Quantcast

Placing documentation after inlined member

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Placing documentation after inlined member

Mircea Neacsu
You are right, that's not what I was looking for. Now the question would
be should I file a bug report or is this an intended behavior?

Mircea Neacsu
Senior Software Engineer

HYPACK Inc.

www: http://www.hypack.com
phone: (514) 694-7158
fax: (514) 227-5380



Ed Trollope wrote:

> Hi there,
>
> I reproduced your problem with 1.5.1, and could only find one easy way to solve it - move the comment for the inline function to before the code
>
> void member();   //!< a member function.
>
> /// documenting member two here to avoid bug
> inline void memeber2 () {};
>
> void member3 ();  //!< documenting member three
>
> I'm guessing that's not what you want to do either though.
>
>
> Ed Trollope
> Senior Engineer
>
> VEGA IT GmbH
> Europaplatz 5
> D-64293 Darmstadt
> Germany
>
> Tel : +49 (0)6151 8257-731
> Fax : +49 (0)6151 8257-799
> Email : [hidden email]
> Web : www.vega-group.com
>
> Register court/Registergericht: Darmstadt, HRB No. 4096, Managing Directors/Geschäftsführer: Philip Cartmell, Susan Bygrave, John Lewis, Robert Rouse
>
> Notice of Confidentiality
>
> This transmission is intended for the named addressee only. It contains information which may be confidential and which may also be privileged.  Unless you are the named addressee (or authorised to receive it for the addressee) you may not copy or use it, or disclose it to anyone else.  If you have received this transmission in error please notify the sender immediately.
>
>
> -----Original Message-----
> From: [hidden email] [mailto:[hidden email]] On Behalf Of Mircea Neacsu
> Sent: 15 May 2007 04:22
> To: [hidden email]
> Subject: [Doxygen-users] Placing documentation after inlined member
>
> I'm trying to place documentation after short inlined functions. A
> typical example would be:
>
> class some_class
> {
> public:
> .....
>     int count () {return the_count;}; ///< Return count of something
> ...
> };
>
> Using Doxygen 1.5.2 the documentation is improperly (at least in my
> opinion) assigned to next member. A full example follows:
>
> /*! A test class */
>
> class Test
> {
>   public:
>     /** An enum type.
>      *  The documentation block cannot be put after the enum!
>      */
>     enum EnumType
>     {
>       int EVal1,     /**< enum value 1 */
>       int EVal2      /**< enum value 2 */
>     };
>     void member();   //!< a member function.
>     void memeber2 () {}; //!< documenting member two
>     void member3 ();  //!< documenting member three
>
>   protected:
>     int value;       /*!< an integer value */
> };
>
> In the generated output member2 is not documented and member3 has the
> following brief description:
> "documenting member two documenting member three"
>
> Any idea on how to get around this problem (apart from converting all my
> inline definitions to inline Test::member2 () {};)
>
> Thanks,
>
> Mircea
>
>
> -------------------------------------------------------------------------
> This SF.net email is sponsored by DB2 Express
> Download DB2 Express C - the FREE version of DB2 express and take
> control of your XML. No limits. Just data. Click to get it now.
> http://sourceforge.net/powerbar/db2/
> _______________________________________________
> Doxygen-users mailing list
> [hidden email]
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
> ______________________________________________________________________
> This email has been scanned by the MessageLabs Email Security System.
> For more information please visit http://www.messagelabs.com/email 
> ______________________________________________________________________
>  

-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Doxygen-users mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
Loading...