Separate Section For Constructors

View: New views
10 Messages — Rating Filter:   Alert me  

Separate Section For Constructors

by Bradley Ward-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Some parts of this message have been removed. Learn more about Nabble's security policy.

I'm a newbie to Doxygen...

 

On the class page, is there a way to get Doxygen to separate the Constructors and Destructors into their own section instead of grouping them in with the Public Member Functions section?

 

Thanks,

 

Brad

 


------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: Separate Section For Constructors

by Milan Gornik-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


Command @group can introduce new method groups. Syntax is the following:




----- Original Message -----
From: Bradley Ward
To: doxygen-users@...
Sent: Tuesday, November 03, 2009 4:25 AM
Subject: [Doxygen-users] Separate Section For Constructors


I'm a newbie to Doxygen...

On the class page, is there a way to get Doxygen to separate the
Constructors and Destructors into their own section instead of grouping them
in with the Public Member Functions section?

Thanks,

Brad



__________ Information from ESET NOD32 Antivirus, version of virus signature
database 4550 (20091028) __________

The message was checked by ESET NOD32 Antivirus.

http://www.eset.com




------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference


__________ Information from ESET NOD32 Antivirus, version of virus signature
database 4550 (20091028) __________

The message was checked by ESET NOD32 Antivirus.

http://www.eset.com





_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users



__________ Information from ESET NOD32 Antivirus, version of virus signature
database 4550 (20091028) __________

The message was checked by ESET NOD32 Antivirus.

http://www.eset.com 


------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: Separate Section For Constructors

by Milan Gornik-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Some parts of this message have been removed. Learn more about Nabble's security policy.
 
I apologize for the previous message, sent it by mistake.

Command @name can introduce new method groups. Syntax is the following:

 /**
  * @name Constructors and destructors
  @{
  */

...your method declarations along with their documentation...

 /**
  @}
  */

 
Hope this helps, regards,
Milan Gornik

----- Original Message -----
From: brad@...
Sent: Tuesday, November 03, 2009 4:25 AM
Subject: [Doxygen-users] Separate Section For Constructors

I'm a newbie to Doxygen...

 

On the class page, is there a way to get Doxygen to separate the Constructors and Destructors into their own section instead of grouping them in with the Public Member Functions section?

 

Thanks,

 

Brad

 



__________ Information from ESET NOD32 Antivirus, version of virus signature database 4550 (20091028) __________

The message was checked by ESET NOD32 Antivirus.

http://www.eset.com


------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference


__________ Information from ESET NOD32 Antivirus, version of virus signature database 4550 (20091028) __________

The message was checked by ESET NOD32 Antivirus.

http://www.eset.com


_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users



__________ Information from ESET NOD32 Antivirus, version of virus signature database 4550 (20091028) __________

The message was checked by ESET NOD32 Antivirus.

http://www.eset.com


------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: Separate Section For Constructors

by Ed of the Mountain :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


Is there a way to make the "Constructors and Destructors" appear as the top subsection of "Public Member Functions" rather than at the end?

Thanks for the tip - I like that!


-Ed


I apologize for the previous message, sent it by mistake.

Command @name can introduce new method groups. Syntax is the following:

 /**
  * @name Constructors and destructors
  @{
  */

...your method declarations along with their documentation...

 /**
  @}
  */


Hope this helps, regards,
Milan Gornik

----- Original Message -----
From: Bradley Ward<mailto:brad@...>
To: doxygen-users@...<mailto:doxygen-users@...>
Sent: Tuesday, November 03, 2009 4:25 AM
Subject: [Doxygen-users] Separate Section For Constructors

I'm a newbie to Doxygen...

On the class page, is there a way to get Doxygen to separate the Constructors and Destructors into their own section instead of grouping them in with the Public Member Functions section?

Thanks,

Brad



__________ Information from ESET NOD32 Antivirus, version of virus signature database 4550 (20091028) __________

The message was checked by ESET NOD32 Antivirus.

http://www.eset.com

________________________________

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference


__________ Information from ESET NOD32 Antivirus, version of virus signature database 4550 (20091028) __________

The message was checked by ESET NOD32 Antivirus.

http://www.eset.com


________________________________

_______________________________________________
Doxygen-users mailing list
Doxygen-users@...<mailto:Doxygen-users@...>
https://lists.sourceforge.net/lists/listinfo/doxygen-users



__________ Information from ESET NOD32 Antivirus, version of virus signature database 4550 (20091028) __________

The message was checked by ESET NOD32 Antivirus.

http://www.eset.com

------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference_______________________________________________
Doxygen-users mailing list
Doxygen-users@...<mailto:Doxygen-users@...>
https://lists.sourceforge.net/lists/listinfo/doxygen-users


------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: Separate Section For Constructors

by Bradley Ward-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Thanks for the tip Milan! This is close, but like Ed, I was really looking
for something that would create this at the same level.

Since the vast majority of new software is being written in object oriented
languages that have constructors (e.g. Java and C#), if I had a vote I would
vote for the constructor section to become a full, main stream section just
like the other sections are already, including full support in the
DoxygenLayout.xml file.

Thanks,

Brad

-----Original Message-----
From: Ed Sutton [mailto:ESutton@...]
Sent: Tuesday, November 03, 2009 8:09 AM
To: doxygen-users@...
Subject: Re: [Doxygen-users] Separate Section For Constructors


Is there a way to make the "Constructors and Destructors" appear as the top
subsection of "Public Member Functions" rather than at the end?

Thanks for the tip - I like that!


-Ed


I apologize for the previous message, sent it by mistake.

Command @name can introduce new method groups. Syntax is the following:

 /**
  * @name Constructors and destructors
  @{
  */

...your method declarations along with their documentation...

 /**
  @}
  */


Hope this helps, regards,
Milan Gornik

----- Original Message -----
From: Bradley Ward<mailto:brad@...>
To:
doxygen-users@...<mailto:doxygen-users@...
et>
Sent: Tuesday, November 03, 2009 4:25 AM
Subject: [Doxygen-users] Separate Section For Constructors

I'm a newbie to Doxygen...

On the class page, is there a way to get Doxygen to separate the
Constructors and Destructors into their own section instead of grouping them
in with the Public Member Functions section?

Thanks,

Brad



__________ Information from ESET NOD32 Antivirus, version of virus signature
database 4550 (20091028) __________

The message was checked by ESET NOD32 Antivirus.

http://www.eset.com

________________________________

----------------------------------------------------------------------------
--
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference


__________ Information from ESET NOD32 Antivirus, version of virus signature
database 4550 (20091028) __________

The message was checked by ESET NOD32 Antivirus.

http://www.eset.com


________________________________

_______________________________________________
Doxygen-users mailing list
Doxygen-users@...<mailto:Doxygen-users@...
et>
https://lists.sourceforge.net/lists/listinfo/doxygen-users



__________ Information from ESET NOD32 Antivirus, version of virus signature
database 4550 (20091028) __________

The message was checked by ESET NOD32 Antivirus.

http://www.eset.com

----------------------------------------------------------------------------
--
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference___________________________________________
____
Doxygen-users mailing list
Doxygen-users@...<mailto:Doxygen-users@...
et>
https://lists.sourceforge.net/lists/listinfo/doxygen-users


----------------------------------------------------------------------------
--
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users


------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: Separate Section For Constructors

by Milan Gornik-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


What if you put all your methods in named groups (just as in first example,
with command @name)? For instance, put your constructors in one named group
and put all other methods of the class in another named group. Leave no
method out of named groups. Will this remove global group that Doxygen makes
by default (public methods)? I think Doxygen puts there all ungrouped
methods. Unfortunately, I can't try out this right now...

Regards,
Milan

----- Original Message -----
From: "Bradley Ward" <brad@...>
To: "'Ed Sutton'" <ESutton@...>;
<doxygen-users@...>
Sent: Tuesday, November 03, 2009 4:22 PM
Subject: Re: [Doxygen-users] Separate Section For Constructors


> Thanks for the tip Milan! This is close, but like Ed, I was really looking
> for something that would create this at the same level.
>
> Since the vast majority of new software is being written in object
> oriented
> languages that have constructors (e.g. Java and C#), if I had a vote I
> would
> vote for the constructor section to become a full, main stream section
> just
> like the other sections are already, including full support in the
> DoxygenLayout.xml file.
>
> Thanks,
>
> Brad
>
> -----Original Message-----
> From: Ed Sutton [mailto:ESutton@...]
> Sent: Tuesday, November 03, 2009 8:09 AM
> To: doxygen-users@...
> Subject: Re: [Doxygen-users] Separate Section For Constructors
>
>
> Is there a way to make the "Constructors and Destructors" appear as the
> top
> subsection of "Public Member Functions" rather than at the end?
>
> Thanks for the tip - I like that!
>
>
> -Ed
>
>
> I apologize for the previous message, sent it by mistake.
>
> Command @name can introduce new method groups. Syntax is the following:
>
> /**
>  * @name Constructors and destructors
>  @{
>  */
>
> ...your method declarations along with their documentation...
>
> /**
>  @}
>  */
>
>
> Hope this helps, regards,
> Milan Gornik
>
> ----- Original Message -----
> From: Bradley Ward<mailto:brad@...>
> To:
> doxygen-users@...<mailto:doxygen-users@...
> et>
> Sent: Tuesday, November 03, 2009 4:25 AM
> Subject: [Doxygen-users] Separate Section For Constructors
>
> I'm a newbie to Doxygen...
>
> On the class page, is there a way to get Doxygen to separate the
> Constructors and Destructors into their own section instead of grouping
> them
> in with the Public Member Functions section?
>
> Thanks,
>
> Brad
>
>
>
> __________ Information from ESET NOD32 Antivirus, version of virus
> signature
> database 4550 (20091028) __________
>
> The message was checked by ESET NOD32 Antivirus.
>
> http://www.eset.com
>
> ________________________________
>
> ----------------------------------------------------------------------------
> --
> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> is the only developer event you need to attend this year. Jumpstart your
> developing skills, take BlackBerry mobile applications to market and stay
> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> http://p.sf.net/sfu/devconference
>
>
> __________ Information from ESET NOD32 Antivirus, version of virus
> signature
> database 4550 (20091028) __________
>
> The message was checked by ESET NOD32 Antivirus.
>
> http://www.eset.com
>
>
> ________________________________
>
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@...<mailto:Doxygen-users@...
> et>
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
>
> __________ Information from ESET NOD32 Antivirus, version of virus
> signature
> database 4550 (20091028) __________
>
> The message was checked by ESET NOD32 Antivirus.
>
> http://www.eset.com
>
> ----------------------------------------------------------------------------
> --
> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> is the only developer event you need to attend this year. Jumpstart your
> developing skills, take BlackBerry mobile applications to market and stay
> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> http://p.sf.net/sfu/devconference___________________________________________
> ____
> Doxygen-users mailing list
> Doxygen-users@...<mailto:Doxygen-users@...
> et>
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
> ----------------------------------------------------------------------------
> --
> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> is the only developer event you need to attend this year. Jumpstart your
> developing skills, take BlackBerry mobile applications to market and stay
> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> http://p.sf.net/sfu/devconference
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
> ------------------------------------------------------------------------------
> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> is the only developer event you need to attend this year. Jumpstart your
> developing skills, take BlackBerry mobile applications to market and stay
> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> http://p.sf.net/sfu/devconference
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
> __________ Information from ESET NOD32 Antivirus, version of virus
> signature database 4550 (20091028) __________
>
> The message was checked by ESET NOD32 Antivirus.
>
> http://www.eset.com
>
>
>


------------------------------------------------------------------------------
Come build with us! The BlackBerry(R) Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay
ahead of the curve. Join us from November 9 - 12, 2009. Register now!
http://p.sf.net/sfu/devconference
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: Separate Section For Constructors

by Ed of the Mountain :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Never, mind Doxygen works as I had hoped AUTOMATICALLY.  Doxygen  
*does* automatically create a "Constructor & Destructors" section at  
the top *if* you documented the constructors and destructors.

I still made use of the section tip by making a "@name Public Signals"  
section for my boost::signal methods.

Thanks for the tips,

-Ed


On Nov 3, 2009, at 9:22 AM, Bradley Ward wrote:

> Thanks for the tip Milan! This is close, but like Ed, I was really  
> looking
> for something that would create this at the same level.
>
> Since the vast majority of new software is being written in object  
> oriented
> languages that have constructors (e.g. Java and C#), if I had a vote  
> I would
> vote for the constructor section to become a full, main stream  
> section just
> like the other sections are already, including full support in the
> DoxygenLayout.xml file.
>
> Thanks,
>
> Brad
>
> -----Original Message-----
> From: Ed Sutton [mailto:ESutton@...]
> Sent: Tuesday, November 03, 2009 8:09 AM
> To: doxygen-users@...
> Subject: Re: [Doxygen-users] Separate Section For Constructors
>
>
> Is there a way to make the "Constructors and Destructors" appear as  
> the top
> subsection of "Public Member Functions" rather than at the end?
>
> Thanks for the tip - I like that!
>
>
> -Ed
>
>
> I apologize for the previous message, sent it by mistake.
>
> Command @name can introduce new method groups. Syntax is the  
> following:
>
> /**
>  * @name Constructors and destructors
>  @{
>  */
>
> ...your method declarations along with their documentation...
>
> /**
>  @}
>  */
>
>
> Hope this helps, regards,
> Milan Gornik
>
> ----- Original Message -----
> From: Bradley Ward<mailto:brad@...>
> To:
> doxygen-users@...<mailto:doxygen-
> users@...
> et>
> Sent: Tuesday, November 03, 2009 4:25 AM
> Subject: [Doxygen-users] Separate Section For Constructors
>
> I'm a newbie to Doxygen...
>
> On the class page, is there a way to get Doxygen to separate the
> Constructors and Destructors into their own section instead of  
> grouping them
> in with the Public Member Functions section?
>
> Thanks,
>
> Brad
>
>
>
> __________ Information from ESET NOD32 Antivirus, version of virus  
> signature
> database 4550 (20091028) __________
>
> The message was checked by ESET NOD32 Antivirus.
>
> http://www.eset.com
>
> ________________________________
>
> ----------------------------------------------------------------------------
> --
> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> is the only developer event you need to attend this year. Jumpstart  
> your
> developing skills, take BlackBerry mobile applications to market and  
> stay
> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> http://p.sf.net/sfu/devconference
>
>
> __________ Information from ESET NOD32 Antivirus, version of virus  
> signature
> database 4550 (20091028) __________
>
> The message was checked by ESET NOD32 Antivirus.
>
> http://www.eset.com
>
>
> ________________________________
>
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@...<mailto:Doxygen-
> users@...
> et>
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
>
> __________ Information from ESET NOD32 Antivirus, version of virus  
> signature
> database 4550 (20091028) __________
>
> The message was checked by ESET NOD32 Antivirus.
>
> http://www.eset.com
>
> ----------------------------------------------------------------------------
> --
> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> is the only developer event you need to attend this year. Jumpstart  
> your
> developing skills, take BlackBerry mobile applications to market and  
> stay
> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> http://p.sf.net/sfu/devconference___________________________________________
> ____
> Doxygen-users mailing list
> Doxygen-users@...<mailto:Doxygen-
> users@...
> et>
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
> ----------------------------------------------------------------------------
> --
> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> is the only developer event you need to attend this year. Jumpstart  
> your
> developing skills, take BlackBerry mobile applications to market and  
> stay
> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> http://p.sf.net/sfu/devconference
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>


------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
trial. Simplify your report design, integration and deployment - and focus on
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: Separate Section For Constructors

by Bradley Ward-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

It does create a section down below where it starts giving the full details
of the documented methods, but I was referring to the top part where it just
does the brief descriptions when I originally started this post. I would
like that top part to automatically separate out the constructors and
destructors instead of grouping the constructors and destructors in with the
methods of the class.

Brad

-----Original Message-----
From: Ed Sutton [mailto:ESutton@...]
Sent: Thursday, November 05, 2009 10:14 AM
Cc: doxygen-users@...
Subject: Re: [Doxygen-users] Separate Section For Constructors

Never, mind Doxygen works as I had hoped AUTOMATICALLY.  Doxygen  
*does* automatically create a "Constructor & Destructors" section at  
the top *if* you documented the constructors and destructors.

I still made use of the section tip by making a "@name Public Signals"  
section for my boost::signal methods.

Thanks for the tips,

-Ed


On Nov 3, 2009, at 9:22 AM, Bradley Ward wrote:

> Thanks for the tip Milan! This is close, but like Ed, I was really  
> looking
> for something that would create this at the same level.
>
> Since the vast majority of new software is being written in object  
> oriented
> languages that have constructors (e.g. Java and C#), if I had a vote  
> I would
> vote for the constructor section to become a full, main stream  
> section just
> like the other sections are already, including full support in the
> DoxygenLayout.xml file.
>
> Thanks,
>
> Brad
>
> -----Original Message-----
> From: Ed Sutton [mailto:ESutton@...]
> Sent: Tuesday, November 03, 2009 8:09 AM
> To: doxygen-users@...
> Subject: Re: [Doxygen-users] Separate Section For Constructors
>
>
> Is there a way to make the "Constructors and Destructors" appear as  
> the top
> subsection of "Public Member Functions" rather than at the end?
>
> Thanks for the tip - I like that!
>
>
> -Ed
>
>
> I apologize for the previous message, sent it by mistake.
>
> Command @name can introduce new method groups. Syntax is the  
> following:
>
> /**
>  * @name Constructors and destructors
>  @{
>  */
>
> ...your method declarations along with their documentation...
>
> /**
>  @}
>  */
>
>
> Hope this helps, regards,
> Milan Gornik
>
> ----- Original Message -----
> From: Bradley Ward<mailto:brad@...>
> To:
> doxygen-users@...<mailto:doxygen-
> users@...
> et>
> Sent: Tuesday, November 03, 2009 4:25 AM
> Subject: [Doxygen-users] Separate Section For Constructors
>
> I'm a newbie to Doxygen...
>
> On the class page, is there a way to get Doxygen to separate the
> Constructors and Destructors into their own section instead of  
> grouping them
> in with the Public Member Functions section?
>
> Thanks,
>
> Brad
>
>
>
> __________ Information from ESET NOD32 Antivirus, version of virus  
> signature
> database 4550 (20091028) __________
>
> The message was checked by ESET NOD32 Antivirus.
>
> http://www.eset.com
>
> ________________________________
>
>
----------------------------------------------------------------------------

> --
> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> is the only developer event you need to attend this year. Jumpstart  
> your
> developing skills, take BlackBerry mobile applications to market and  
> stay
> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> http://p.sf.net/sfu/devconference
>
>
> __________ Information from ESET NOD32 Antivirus, version of virus  
> signature
> database 4550 (20091028) __________
>
> The message was checked by ESET NOD32 Antivirus.
>
> http://www.eset.com
>
>
> ________________________________
>
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@...<mailto:Doxygen-
> users@...
> et>
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
>
> __________ Information from ESET NOD32 Antivirus, version of virus  
> signature
> database 4550 (20091028) __________
>
> The message was checked by ESET NOD32 Antivirus.
>
> http://www.eset.com
>
>
----------------------------------------------------------------------------
> --
> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> is the only developer event you need to attend this year. Jumpstart  
> your
> developing skills, take BlackBerry mobile applications to market and  
> stay
> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
>
http://p.sf.net/sfu/devconference___________________________________________
> ____
> Doxygen-users mailing list
> Doxygen-users@...<mailto:Doxygen-
> users@...
> et>
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
>
----------------------------------------------------------------------------

> --
> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> is the only developer event you need to attend this year. Jumpstart  
> your
> developing skills, take BlackBerry mobile applications to market and  
> stay
> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> http://p.sf.net/sfu/devconference
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>


----------------------------------------------------------------------------
--
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
trial. Simplify your report design, integration and deployment - and focus
on
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users


------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
trial. Simplify your report design, integration and deployment - and focus on
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: Separate Section For Constructors

by Bradley Ward-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Wait - I just re-read Ed's comment again after I sent my response right now.
Ed said it was "at the top".  This is very strange, because it is not
working that way for me.

For example, I have a class called ExcelReader with 2 constructors. What I
am getting is this:

(Header) Public Methods

then just below that I have:

                ExcelReader(FileInfo file)

                ExcelReader()

        void Close()

        ... followed by the rest of the public methods ...

So as you can see, in my case it is ordering things by putting the
constructors first in the list, then following with methods, but it is not
putting them into a separate section. But Ed says it is for him. I wonder
what is different about mine (or Ed's)???

Also, in my example, I'd prefer for the default (no-argument) constructor to
be listed first. If anyone knows of a way to accomplish that, please let me
know.

Thanks,

Brad

     
-----Original Message-----
From: Ed Sutton [mailto:ESutton@...]
Sent: Thursday, November 05, 2009 10:14 AM
Cc: doxygen-users@...
Subject: Re: [Doxygen-users] Separate Section For Constructors

Never, mind Doxygen works as I had hoped AUTOMATICALLY.  Doxygen  
*does* automatically create a "Constructor & Destructors" section at  
the top *if* you documented the constructors and destructors.

I still made use of the section tip by making a "@name Public Signals"  
section for my boost::signal methods.

Thanks for the tips,

-Ed


On Nov 3, 2009, at 9:22 AM, Bradley Ward wrote:

> Thanks for the tip Milan! This is close, but like Ed, I was really  
> looking
> for something that would create this at the same level.
>
> Since the vast majority of new software is being written in object  
> oriented
> languages that have constructors (e.g. Java and C#), if I had a vote  
> I would
> vote for the constructor section to become a full, main stream  
> section just
> like the other sections are already, including full support in the
> DoxygenLayout.xml file.
>
> Thanks,
>
> Brad
>
> -----Original Message-----
> From: Ed Sutton [mailto:ESutton@...]
> Sent: Tuesday, November 03, 2009 8:09 AM
> To: doxygen-users@...
> Subject: Re: [Doxygen-users] Separate Section For Constructors
>
>
> Is there a way to make the "Constructors and Destructors" appear as  
> the top
> subsection of "Public Member Functions" rather than at the end?
>
> Thanks for the tip - I like that!
>
>
> -Ed
>
>
> I apologize for the previous message, sent it by mistake.
>
> Command @name can introduce new method groups. Syntax is the  
> following:
>
> /**
>  * @name Constructors and destructors
>  @{
>  */
>
> ...your method declarations along with their documentation...
>
> /**
>  @}
>  */
>
>
> Hope this helps, regards,
> Milan Gornik
>
> ----- Original Message -----
> From: Bradley Ward<mailto:brad@...>
> To:
> doxygen-users@...<mailto:doxygen-
> users@...
> et>
> Sent: Tuesday, November 03, 2009 4:25 AM
> Subject: [Doxygen-users] Separate Section For Constructors
>
> I'm a newbie to Doxygen...
>
> On the class page, is there a way to get Doxygen to separate the
> Constructors and Destructors into their own section instead of  
> grouping them
> in with the Public Member Functions section?
>
> Thanks,
>
> Brad
>
>
>
> __________ Information from ESET NOD32 Antivirus, version of virus  
> signature
> database 4550 (20091028) __________
>
> The message was checked by ESET NOD32 Antivirus.
>
> http://www.eset.com
>
> ________________________________
>
>
----------------------------------------------------------------------------

> --
> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> is the only developer event you need to attend this year. Jumpstart  
> your
> developing skills, take BlackBerry mobile applications to market and  
> stay
> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> http://p.sf.net/sfu/devconference
>
>
> __________ Information from ESET NOD32 Antivirus, version of virus  
> signature
> database 4550 (20091028) __________
>
> The message was checked by ESET NOD32 Antivirus.
>
> http://www.eset.com
>
>
> ________________________________
>
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@...<mailto:Doxygen-
> users@...
> et>
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
>
> __________ Information from ESET NOD32 Antivirus, version of virus  
> signature
> database 4550 (20091028) __________
>
> The message was checked by ESET NOD32 Antivirus.
>
> http://www.eset.com
>
>
----------------------------------------------------------------------------
> --
> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> is the only developer event you need to attend this year. Jumpstart  
> your
> developing skills, take BlackBerry mobile applications to market and  
> stay
> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
>
http://p.sf.net/sfu/devconference___________________________________________
> ____
> Doxygen-users mailing list
> Doxygen-users@...<mailto:Doxygen-
> users@...
> et>
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
>
----------------------------------------------------------------------------

> --
> Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> is the only developer event you need to attend this year. Jumpstart  
> your
> developing skills, take BlackBerry mobile applications to market and  
> stay
> ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> http://p.sf.net/sfu/devconference
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>


----------------------------------------------------------------------------
--
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
trial. Simplify your report design, integration and deployment - and focus
on
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users


------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
trial. Simplify your report design, integration and deployment - and focus on
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: Separate Section For Constructors

by Ed of the Mountain :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Sorry, for confusing things.  While documenting constructors auto-generates the "Constructor & Destructor Documentation" section", which is great, but is not ideal. See example:

Public Member Functions
MyClass(string name) // Constructor
int Method1()
int Method2()
int Method3()

Constructor & Destructor Documentation
MyClass(string name)

Member Function Documentation
int Method1()
int Method2()
int Method3()

See example below after adding a @name Constructors around the constructor generates the following:

Public Member Functions
MyClass(string name) // Constructor
int Method1()
int Method2()
int Method3()

- Constructors // Displays as subsection of "Public Member Functions"
MyClass(string name) // Constructor appears a *second time* as a subsection of "Public Member Functions"

Constructor & Destructor Documentation
MyClass(string name)

Member Function Documentation
int Method1()
int Method2()
int Method3()

I do not like this approach because the constructor appears *twice* in the "Public Member Functions" sections.

As an ideal example, I would prefer to have the constructor(s) automatically grouped in a " Public Constructors" at the top in the "Public Member Functions" grouped at the top.  For example:

Public Constructors
MyClass(string name) // Constructor

Public Member Functions
MyClass(string name) // Constructor
int Method1()
int Method2()
int Method3()

Member Function Documentation
int Method1()
int Method2()
int Method3()

Any tips on how to accomplish are appreciated.

-Ed


> -----Original Message-----
> From: Bradley Ward [mailto:brad@...]
> Sent: Thursday, November 05, 2009 9:54 AM
> To: Ed Sutton
> Cc: doxygen-users@...
> Subject: RE: [Doxygen-users] Separate Section For Constructors
>
> Wait - I just re-read Ed's comment again after I sent my response right
> now.
> Ed said it was "at the top".  This is very strange, because it is not
> working that way for me.
>
> For example, I have a class called ExcelReader with 2 constructors. What
> I
> am getting is this:
>
> (Header) Public Methods
>
> then just below that I have:
>
> ExcelReader(FileInfo file)
>
> ExcelReader()
>
> void Close()
>
> ... followed by the rest of the public methods ...
>
> So as you can see, in my case it is ordering things by putting the
> constructors first in the list, then following with methods, but it is
> not
> putting them into a separate section. But Ed says it is for him. I
> wonder
> what is different about mine (or Ed's)???
>
> Also, in my example, I'd prefer for the default (no-argument)
> constructor to
> be listed first. If anyone knows of a way to accomplish that, please let
> me
> know.
>
> Thanks,
>
> Brad
>
>
> -----Original Message-----
> From: Ed Sutton [mailto:ESutton@...]
> Sent: Thursday, November 05, 2009 10:14 AM
> Cc: doxygen-users@...
> Subject: Re: [Doxygen-users] Separate Section For Constructors
>
> Never, mind Doxygen works as I had hoped AUTOMATICALLY.  Doxygen
> *does* automatically create a "Constructor & Destructors" section at
> the top *if* you documented the constructors and destructors.
>
> I still made use of the section tip by making a "@name Public Signals"
> section for my boost::signal methods.
>
> Thanks for the tips,
>
> -Ed
>
>
> On Nov 3, 2009, at 9:22 AM, Bradley Ward wrote:
>
> > Thanks for the tip Milan! This is close, but like Ed, I was really
> > looking
> > for something that would create this at the same level.
> >
> > Since the vast majority of new software is being written in object
> > oriented
> > languages that have constructors (e.g. Java and C#), if I had a vote
> > I would
> > vote for the constructor section to become a full, main stream
> > section just
> > like the other sections are already, including full support in the
> > DoxygenLayout.xml file.
> >
> > Thanks,
> >
> > Brad
> >
> > -----Original Message-----
> > From: Ed Sutton [mailto:ESutton@...]
> > Sent: Tuesday, November 03, 2009 8:09 AM
> > To: doxygen-users@...
> > Subject: Re: [Doxygen-users] Separate Section For Constructors
> >
> >
> > Is there a way to make the "Constructors and Destructors" appear as
> > the top
> > subsection of "Public Member Functions" rather than at the end?
> >
> > Thanks for the tip - I like that!
> >
> >
> > -Ed
> >
> >
> > I apologize for the previous message, sent it by mistake.
> >
> > Command @name can introduce new method groups. Syntax is the
> > following:
> >
> > /**
> >  * @name Constructors and destructors
> >  @{
> >  */
> >
> > ...your method declarations along with their documentation...
> >
> > /**
> >  @}
> >  */
> >
> >
> > Hope this helps, regards,
> > Milan Gornik
> >
> > ----- Original Message -----
> > From: Bradley Ward<mailto:brad@...>
> > To:
> > doxygen-users@...<mailto:doxygen-
> > users@...
> > et>
> > Sent: Tuesday, November 03, 2009 4:25 AM
> > Subject: [Doxygen-users] Separate Section For Constructors
> >
> > I'm a newbie to Doxygen...
> >
> > On the class page, is there a way to get Doxygen to separate the
> > Constructors and Destructors into their own section instead of
> > grouping them
> > in with the Public Member Functions section?
> >
> > Thanks,
> >
> > Brad
> >
> >
> >
> > __________ Information from ESET NOD32 Antivirus, version of virus
> > signature
> > database 4550 (20091028) __________
> >
> > The message was checked by ESET NOD32 Antivirus.
> >
> > http://www.eset.com
> >
> > ________________________________
> >
> >
> ------------------------------------------------------------------------
> ----
> > --
> > Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> > is the only developer event you need to attend this year. Jumpstart
> > your
> > developing skills, take BlackBerry mobile applications to market and
> > stay
> > ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> > http://p.sf.net/sfu/devconference
> >
> >
> > __________ Information from ESET NOD32 Antivirus, version of virus
> > signature
> > database 4550 (20091028) __________
> >
> > The message was checked by ESET NOD32 Antivirus.
> >
> > http://www.eset.com
> >
> >
> > ________________________________
> >
> > _______________________________________________
> > Doxygen-users mailing list
> > Doxygen-users@...<mailto:Doxygen-
> > users@...
> > et>
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
> >
> >
> >
> > __________ Information from ESET NOD32 Antivirus, version of virus
> > signature
> > database 4550 (20091028) __________
> >
> > The message was checked by ESET NOD32 Antivirus.
> >
> > http://www.eset.com
> >
> >
> ------------------------------------------------------------------------
> ----
> > --
> > Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> > is the only developer event you need to attend this year. Jumpstart
> > your
> > developing skills, take BlackBerry mobile applications to market and
> > stay
> > ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> >
> http://p.sf.net/sfu/devconference_______________________________________
> ____
> > ____
> > Doxygen-users mailing list
> > Doxygen-users@...<mailto:Doxygen-
> > users@...
> > et>
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
> >
> >
> >
> ------------------------------------------------------------------------
> ----
> > --
> > Come build with us! The BlackBerry(R) Developer Conference in SF, CA
> > is the only developer event you need to attend this year. Jumpstart
> > your
> > developing skills, take BlackBerry mobile applications to market and
> > stay
> > ahead of the curve. Join us from November 9 - 12, 2009. Register now!
> > http://p.sf.net/sfu/devconference
> > _______________________________________________
> > Doxygen-users mailing list
> > Doxygen-users@...
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
> >
>
>
> ------------------------------------------------------------------------
> ----
> --
> Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-
> Day
> trial. Simplify your report design, integration and deployment - and
> focus
> on
> what you do best, core application coding. Discover what's new with
> Crystal Reports now.  http://p.sf.net/sfu/bobj-july
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users


------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
trial. Simplify your report design, integration and deployment - and focus on
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users