I do this by using groups and group nesting, using @defgroup, @addtogroup,
@{, @}, and @ingroup. For any groups that need top-level documentation, I
can use a separate .dox file of text and images. For our mainpage, I use an
image that has <a href="modules.html"> to post the list of groups and
modules when you click on the image.
I hope that helps.
- Damon
|------------>
| From: |
|------------>
>---------------------------------------------------------------------------------------------------------------------------------------------|
|admsugar <asugar...@osisoft.com>
|
>---------------------------------------------------------------------------------------------------------------------------------------------|
|------------>
| To: |
|------------>
>---------------------------------------------------------------------------------------------------------------------------------------------|
|<doxygen-users@lists.sourceforge.net>
|
>---------------------------------------------------------------------------------------------------------------------------------------------|
|------------>
| Date: |
|------------>
>---------------------------------------------------------------------------------------------------------------------------------------------|
|07/16/2013 01:00 PM
|
>---------------------------------------------------------------------------------------------------------------------------------------------|
|------------>
| Subject: |
|------------>
>---------------------------------------------------------------------------------------------------------------------------------------------|
|[Doxygen-users] Including documentation on homepage of user groups?
|
>---------------------------------------------------------------------------------------------------------------------------------------------|
<http://doxygen.10944.n7.nabble.com/file/n6144/Untitled.png>
In my project (as shown in the image), I have a user group of tabs titled
'API'. In this user group one can access all documentation generated from
source code such as classes, ect (as shown on left navigation tree).
Is it possible for me to create a .dox file with just text and reference it
to my user group so I can have a homepage (so to speak) for the 'API'
group?
As it is now (in the picture), the API just has a blank page with
navigation
to the documentation just in the navigation tree. I would like to add some
background info on the blank page for the user, and maybe even reference in
that text links to each part of the documentation (using the \ref
hopefully).
Am I far off? I'm not sure how to reference the user group page that I
created.
Thanks.
--
View this message in context:
http://doxygen.10944.n7.nabble.com/Including-documentation-on-homepage-of-user-groups-tp6144.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.
------------------------------------------------------------------------------
See everything from the browser to the database with AppDynamics
Get end-to-end visibility with application monitoring from AppDynamics
Isolate bottlenecks and diagnose root cause in seconds.
Start your free trial of AppDynamics Pro today!
http://pubads.g.doubleclick.net/gampad/clk?id=48808831&iu=/4140/ostg.clktrk
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
------------------------------------------------------------------------------
See everything from the browser to the database with AppDynamics
Get end-to-end visibility with application monitoring from AppDynamics
Isolate bottlenecks and diagnose root cause in seconds.
Start your free trial of AppDynamics Pro today!
http://pubads.g.doubleclick.net/gampad/clk?id=48808831&iu=/4140/ostg.clktrk
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
