[Developers] Doxyben

[John Sibert]

Hi Hans,
Thanks for the feedback. doxygen is indeed deep and flexible. A little 
perusing of the doxygen manual provided some easy relief. The changes I 
made should show up the next time the dox are generated on the server. 
Some comments are embedded in your email below.

Here are the changes I committed to the revision 720.

> ===================================================================
> --- Doxyfile    (revision 716)
> +++ Doxyfile    (working copy)
> @@ -571,7 +571,7 @@
>  # This will remove the Namespaces entry from the Quick Index
>  # and from the Folder Tree View (if specified). The default is YES.
>
> -SHOW_NAMESPACES        = YES
> +SHOW_NAMESPACES        = NO
>
>  # The FILE_VERSION_FILTER tag can be used to specify a program or 
> script that
>  # doxygen should invoke to get the current version for each file 
> (typically from
> Index: dox-share/mainpage.txt
> ===================================================================
> --- dox-share/mainpage.txt    (revision 716)
> +++ dox-share/mainpage.txt    (working copy)
> @@ -124,3 +124,38 @@
>      \ingroup CONTRIB
>      \details Contributed by Weihai Liu
>  */
> +
> +// generate dox for directories
> +/** \dir src
> +Main AUTODIF and ADMB source code directories.
> +*/
> +/** \dir linad99
> +Home of \ref fvar.hpp and the source files for most of th AUTODIF 
> library.
> +*/
> +/** \dir nh99
> +Source files for ADMB
> +*/
> +/** \dir df1b2-separable
> +Source files for random effects models.
> +*/
> +/** \dir tools99
> +Source files for "tools" such as the \ref cifstream and \ref adstring 
> classes.
> +*/
> +/** \dir sparse
> +Not sure what lives here.
> +*/
> +/** \dir contrib
> +Houses the contributed libraries
> +*/
> +/** \dir ecolib
> +Source code for ECOL Functions Useful in Ecology;
> +contributed by Mollie Brooks.
> +*/
> +/** \dir qfclib
> +QFC Functions created at the Quantitative Fisheries Center(QFC),
> +Michigan State University; Contributed by Weihai Liu.
> +*/
> +/** \dir statslib
> +STATLIB Statistical Fuctions; contributed by Steven Martell.
> +*/
> +

If anyone is interested in fooling around try the following changes to 
Doxyfile:

GENERATE_TREEVIEW      = YES
will generate a tree structure in a side panel which essentially 
duplicates the information in the tabs.

DISABLE_INDEX          = YES
will disable the tabs completely.

I'd be interested in what you think.

Cheers,
John

John Sibert
Emeritus Researcher, SOEST
University of Hawaii at Manoa

Visit the ADMB project http://admb-project.org/

On 12/10/2012 04:29 AM, Hans J. Skaug wrote:
> Developers,
>
> Every time I look at the online Doxygen docs it strikes me how nice a setup this is,
> and that we should have more content. A few technical  issues:
>
> - Under the Directory tab it would be nice to have a brief explanation
>    of the content of each directory. Is this technically possible?
>
>    As far as I know the "directory logic" of ADMB is not documented elsewhere.
The \dir special command enables primitive documentation for 
directories. For want of  a more logical place to put the information, I 
placed the dox for directories in dox-share/mainpage.txt. I might be 
easier to maintain in the long run  to create separate files that live 
in appropriate directories, eg. linad99.txt in linad99.
>
> - Under Modules, when you choose an entry, and then choose
>    Functions, multiple functions with the same name (but different argument types)
>    are listed together. This takes up a lot of space. It would be nice if each function name
>    occurred only once, but that all the different variants showed up when you clicked on the function name.
>    Is this technically possible?
>    The search field works this "incremental" way (try for instance "log_" in the search field).
Tricky. I was unable to find a quick solution to this issue in the 
manual. However there is the \overload [(function declaration)] listed. 
It would seem to require extensive changes to existing dox. Some 
experimentation would seem to be in order.
>   
> - Are the names Namespaces relevant? If not the tab can be removed.
No.
SHOW_NAMESPACES        = NO
in Doxyfile gets rid of the Namepaces tab
>
> Hans
>
> _______________________________________________
> Developers mailing list
> Developers at admb-project.org
> http://lists.admb-project.org/mailman/listinfo/developers
>