On Jul 16, 2013, at 18:59 , admsugar <[email protected]> wrote:
> <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.
You could define your index like this:
<navindex>
<tab type="mainpage" visible="yes" title=""/>
<tab type="usergroup" title="API" url="@ref api">
<!--<tab type="pages" visible="yes" title="" intro=""/>-->
<tab type="modules" visible="yes" title="" intro=""/>
<tab type="namespaces" visible="yes" title="">
<tab type="namespacelist" visible="yes" title="" intro=""/>
<tab type="namespacemembers" visible="yes" title="" intro=""/>
</tab>
<tab type="classes" visible="yes" title="">
<tab type="classlist" visible="yes" title="" intro=""/>
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="hierarchy" visible="yes" title="" intro=""/>
<tab type="classmembers" visible="yes" title="" intro=""/>
</tab>
<tab type="files" visible="yes" title="">
<tab type="filelist" visible="yes" title="" intro=""/>
<tab type="globals" visible="yes" title="" intro=""/>
</tab>
<tab type="examples" visible="yes" title="" intro=""/>
</tab>
<tab type="user" title="Installation" url="@ref install"/>
</navindex>
Note that I commented out the 'pages' tab and defined the pages as
usergroup/user type tabs manually and used @ref to refer to the page.
In .dox files you can then define the pages as follows:
/** @page api API
The API page.
*/
/** @page install Installation
Installation instructions.
*/
I hope this helps,
Regards,
Dimitri
------------------------------------------------------------------------------
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
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
