Классы с @cond показывают, когда для HIDE_UNDOC_MEMBERS установлено значение YES - PullRequest
Новая
       13

Классы с @cond показывают, когда для HIDE_UNDOC_MEMBERS установлено значение YES

1 голос
/ 21 марта 2019

В моем файле .doxy установлены следующие строки: 

EXTRACT_ALL            = NO
HIDE_UNDOC_MEMBERS     = YES
HIDE_UNDOC_CLASSES     = YES

Мои классы c # имеют такую ​​структуру: 

public class Foo {
    public Bar bar { get; set; }
    ...
}

// @cond Beta
public class Bar {
        ...
}
// @endcond

Бета не устанавливается в строке ENABLED_SECTIONS.

Проблема здесь в том, что свойство bar отображается на странице для Foo. Аннотация @cond эффективна для того, чтобы запретить Bar иметь свою собственную страницу, поэтому не следует ли считать Bar недокументированной и скрытой от страницы Foo, поскольку для HIDE_UNDOC_MEMBERS установлено значение YES?

Результаты doxygen -x: 

C:\Users\mille>doxygen -x "D:\Company\Sandbox\Proj9.4\Proj\Api.DocGenerator\doxy\Proj API.doxy"
# Difference with default Doxyfile 1.8.15
PROJECT_NAME           = "Proj API"
PROJECT_BRIEF          = "Web services for communicating with Proj"
PROJECT_LOGO           = ../../Api.WebService/devhelp/logo_Proj.png
OUTPUT_DIRECTORY       = ../DocFiles
SUBGROUPING            = NO
EXTRACT_PACKAGE        = YES
EXTRACT_STATIC         = YES
HIDE_UNDOC_MEMBERS     = YES
HIDE_UNDOC_CLASSES     = YES
SHOW_INCLUDE_FILES     = NO
SHOW_USED_FILES        = NO
SHOW_FILES             = NO
INPUT                  = ../../Api
FILE_PATTERNS          = *.c \x
                         *.cc \
                         *.cxx \
                         *.cpp \
                         *.c++ \
                         *.d \
                         *.java \
                         *.ii \
                         *.ixx \
                         *.ipp \
                         *.i++ \
                         *.inl \
                         *.h \
                         *.hh \
                         *.hxx \
                         *.hpp \
                         *.h++ \
                         *.idl \
                         *.odl \
                         *.cs \
                         *.php \
                         *.php3 \
                         *.inc \
                         *.m \
                         *.markdown \
                         *.md \
                         *.mm \
                         *.dox \
                         *.py \
                         *.f90 \
                         *.f \
                         *.for \
                         *.vhd \
                         *.vhdl
RECURSIVE              = YES
EXCLUDE                = ../../Api/XmlSerialization.cs
EXCLUDE_PATTERNS       = *Service.cs \
                         *Plugin.cs \
                         *Validation/* \
                         *Filters/*
USE_MDFILE_AS_MAINPAGE = readme.md
HTML_OUTPUT            = docs
HTML_COLORSTYLE_HUE    = 354
HTML_TIMESTAMP         = YES
HTML_DYNAMIC_SECTIONS  = YES
ENUM_VALUES_PER_LINE   = 1
MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
GENERATE_LATEX         = NO
LATEX_CMD_NAME         = latex
RTF_HYPERLINKS         = YES

Спасибо

...