[LLVMbugs] [Bug 778] NEW: Doxygen Documentation Is Lacking

bugzilla-daemon at cs.uiuc.edu bugzilla-daemon at cs.uiuc.edu
Mon May 15 12:39:38 PDT 2006


           Summary: Doxygen Documentation Is Lacking
           Product: Documentation
           Version: trunk
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: normal
          Priority: P2
         Component: Doxygen
        AssignedTo: unassignedbugs at nondot.org
        ReportedBy: rspencer at x10sys.com

Currently, there is only partial support for doxygen documentation in the public
header files. The following improvements are requested:

1. Move "file level" comments that actually describe a class to be associated
with the class so doxygen user's don't have to dig for it and so doxygen doesn't
ignore it.

2. Group class members into sections of related functionality so that the those
groups are expressed in the documentation. This makes it much easier to find the
appropriate methods because entire groups can be quickly ignored if they are
off-topic for the reader's intention.

3. Resolve the @brief issue (the @brief keyword shows up in the output)

4. Get a non-blank main page (introduction) so that people can get a basic idea
of what it is they're reading about.

------- You are receiving this mail because: -------
You are on the CC list for the bug, or are watching someone who is.

More information about the llvm-bugs mailing list