Bug #48

user contrib doxygen

Added by Mollie Brooks about 2 years ago. Updated over 1 year ago.

Status:ClosedStart date:03/16/2012
Priority:NormalDue date:
Assignee:John Sibert% Done:

0%

Category:-
Target version:-

Description

statlib is the only user contributed library that shows the doxygen info here
http://admb-project.org/documentation/api/group__CONTRIB.html

They do come up if I search for them, or here
http://admb-project.org/documentation/api/dir_b984b43274d00fb28513dce8dcf66f9f.html

History

#1 Updated by Johnoel Ancheta almost 2 years ago

  • Assignee set to John Sibert

John is the doxygen guy.

#2 Updated by John Sibert over 1 year ago

  • Status changed from New to Resolved
There were two general causes for this issue:
  1. There was an error on the INPUT section of Doxyfile specifying the path to the QFC directory.
  2. The \ingroup Doxygen special command must appear in the dox comments for each function.

These are fixed on r579

Related comment. Putting the \ingroup command in the dox for the file
causes the file names to also be listed in the Modules tab. This has the effect
of making it hard to find the dox for the individual functions in each file.

#3 Updated by John Sibert over 1 year ago

Authors of the contributed libaries should insert the appropriate \ingroup special commands in the function documentation blocks and remove them from the \file documentation blocks.

#4 Updated by Johnoel Ancheta over 1 year ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF