[mapguide-users] EXTERNAL_API not documented in doxygen

[Jim O'Leary]

Is there a good reason why some public methods are not documented in the
doxygen output for MGOS? For example, in a typical code sample I see:

$site = new MgSite();
$site->Open($userInfo);

These methods are not documented in the doxygen output, which could be
confusing if you are trying to understand the code. However, in the source
code at:

Common\MapGuideCommon\Services.Site.h

I see:

EXTERNAL_API:

   
///////////////////////////////////////////////////////////////////////////////////
    /// \brief
    /// Construct an MgSite object and open a connection to the Site Server.
    ///
    /// \return
    /// Nothing
    ///
    MgSite();

   
///////////////////////////////////////////////////////////////////////////////////
    /// \brief
    /// Opens a connection to the Site Server.
    ///
    /// \param userInformation
    /// User information to authenticate against
    ///
    /// \return
    /// Nothing
    ///
    /// \exception MgNullArgumentException
    /// \exception MgAuthenticationFailedException
    /// \exception MgConnectionFailedException
    ///
    void Open(MgUserInformation* userInformation);

...and other methods. So it appears that code that is under EXTERNAL_API
does not make it into doxygen.

Thanks.
-- 
View this message in context: http://www.nabble.com/EXTERNAL_API-not-documented-in-doxygen-tf4704536s16610.html#a13447448
Sent from the MapGuide Users mailing list archive at Nabble.com.