[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#725122: marked as done (doxygen: Struct member fields not documented with INLINE_SIMPLE_STRUCTS)

Your message dated Tue, 17 Apr 2018 17:30:57 +0200
with message-id <efb5b09a-ef5f-cc7b-36f1-27ef6b6bc80b@libpf.com>
and subject line resolved
has caused the Debian Bug report #725122,
regarding doxygen: Struct member fields not documented with INLINE_SIMPLE_STRUCTS
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@bugs.debian.org
immediately.)


-- 
725122: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=725122
Debian Bug Tracking System
Contact owner@bugs.debian.org with problems
--- Begin Message --- 
Package: doxygen
Version: 1.8.4-1
Severity: normal
Tags: upstream

Hello,

The structures are not fully documented when INLINE_SIMPLE_STRUCTS is
enabled. I'm attaching a simple test file (teststruct.h) and a minimal
Doxyfile that will generate a man page, LaTeX and HTML. In all cases,
the structure's members are not documented, whereas disabling
INLINE_SIMPLE_STRUCTS produces a dedicated page or section where the
fields appear.

This bug is still present in the last upstream version (1.8.5).

Cheers,
  Matteo

-- System Information:
Debian Release: jessie/sid
  APT prefers unstable
  APT policy: (500, 'unstable')
Architecture: amd64 (x86_64)

Kernel: Linux 3.2.0-4-amd64 (SMP w/2 CPU cores)
Locale: LANG=fr_FR.UTF-8, LC_CTYPE=fr_FR.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash

Versions of packages doxygen depends on:
ii  libc6       2.17-93
ii  libgcc1     1:4.8.1-10
ii  libstdc++6  4.8.1-10

Versions of packages doxygen recommends:
ii  doxygen-latex  1.8.4-1

Versions of packages doxygen suggests:
pn  doxygen-doc  <none>
pn  doxygen-gui  <none>
ii  graphviz     2.26.3-15+b1

-- no debconf information

DOXYFILE_ENCODING      = UTF-8
PROJECT_NAME           = "Test Project"
PROJECT_BRIEF          = "Brief description of Test Project"
REPEAT_BRIEF           = NO
FULL_PATH_NAMES        = NO
MULTILINE_CPP_IS_BRIEF = YES
OPTIMIZE_OUTPUT_FOR_C  = YES
INLINE_SIMPLE_STRUCTS  = YES
EXTRACT_LOCAL_CLASSES  = NO
HIDE_UNDOC_MEMBERS     = YES
HIDE_UNDOC_CLASSES     = YES
SHOW_INCLUDE_FILES     = NO
QUIET                  = NO
INPUT                  = teststruct.h
GENERATE_HTML          = YES
GENERATE_LATEX         = YES
GENERATE_MAN           = YES

/**
 * @file teststruct.h
 * @brief Test Doxygen doc for structures
 *
 * Test Struct Project is a test for Doxygen and this is its detailed
 * description.
 */

/// Test structure
/**
 * Detailed description of the test structure.
 */
struct mystruct {
  int i; ///< An int
  char c; ///< A char
};

--- End Message ---
--- Begin Message --- 
I tested today with 1.8.13 in sid with the attached test case.

As upstream stated 1,5 years ago: all the member descriptions (brief and long) appear.

Paolo

Attachment: 725122.tar
Description: Unix tar archive


--- End Message ---
Reply to: