"function-centric" documentation

[Sasha Sirotkin]

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

Hello.

 

Hope this was not discussed before. Is it possible to create a “function-centric” documentation ? By default, doxygen documents “files”, everything is group by and index by file. However, this is not the way most people use documentation. For most people it is more important to understand what functions are there and what they do then where exactly they are located.

 

Is it possible to make doxygen generate a documentation that would look like a list of functions a data structures (possible grouped by some used defined criteria) ?

 

Thanks

---

IMPORTANT: The contents of this email and any attachments are confidential. They are intended for the named recipient(s) only.
If you have received this email in error, please notify the system manager or the sender immediately and do not disclose the contents to anyone or make copies thereof.
*** eSafe scanned this email for viruses, vandals, and malicious content. ***

---

------------------------------------------------------------------------------
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

[Spencer Collyer]

On Sun, 25 Oct 2009 18:38:39 +0200, Sasha Sirotkin wrote:

> Hello.
>
>  
>
> Hope this was not discussed before. Is it possible to create a
> "function-centric" documentation ? By default, doxygen documents
> "files", everything is group by and index by file. However, this is
> not the way most people use documentation. For most people it is more
> important to understand what functions are there and what they do then
> where exactly they are located.
>
>  
>
> Is it possible to make doxygen generate a documentation that would
> look like a list of functions a data structures (possible grouped by
> some used defined criteria) ?

You can use the @defgroup, @addtogroup, and @ingroup commands to generate groups of functions (or anything really). The groups get listed under the 'Modules' heading.

Spencer

--
<<< Eagles may soar, but weasels don't get sucked into jet engines >>>
8:08am up 59 days 15:05, 1 user, load average: 1.35, 1.44, 1.22
Registered Linux User #232457 | LFS ID 11703

------------------------------------------------------------------------------
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