After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 304377 - Hide field detail in HTML output when detail absent
Hide field detail in HTML output when detail absent
Status: RESOLVED NOTABUG
Product: doxygen
Classification: Other
Component: general
1.4.x
Other All
: Normal enhancement
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2005-05-16 16:37 UTC by Michael McTernan
Modified: 2005-05-16 20:41 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Michael McTernan 2005-05-16 16:37:20 UTC
Version details: 1.4.2

If a C structure has only a brief documentation comment, the field specific
documentation could be omitted.  e.g. (using JAVADOC_AUTOBRIEF=YES)

typedef struct ExampleTag
{
  /** Good variable.
   * This variable is very good.
   */
  int goodCount;

  /** Bad variable */
  int badCount;
}
Example;

In the above example, both goodCount and badCount will get an entry in the "Data
Fields" section of the output HTML and but both variables will have links to
"Field Documentation", which in the case of badCount will be blank.

The output could be more concise if an option to hide "Field Documentation" when
only brief docs are present was available.
Comment 1 Michael McTernan 2005-05-16 20:41:12 UTC
Ha!

EXTRACT_ALL was set to YES causing all fields to generate documentation despite
the lack of a detailed description in the source I was processing.

So this is not a mistake and is actually documented in the Doxygen manual as
being the desired behaviour.

Appologies for my foolishness....