Doxygen: cacher la méthode privée / protégée ... et astuces

Je suis Doxygen pour générer la documentation de l'API, écrit en C#. Toutefois, il expose privé/protégé membres. Est-il un moyen de cacher ces choses?

J'ai compris comment cacher des fichiers: EXCLUDE = Liste de noms de fichiers

Encore, j'ai besoin de plus de précision et donc de bouclier utilisateurs inutiles API de bruit. Un exemple de Doxygen fichier serait appréciée ainsi que des conseils/astuces.

Quels sont les outils que vous utilisez pour générer de l'API à partir du code source?

Je me sens un peu gauche dans le 18ème siècle comme je l'ai utiliser Doxygen en C# par voie de C++.

source d'informationauteur

  1. 19

    Je ne sais pas comment bien le C# est pris en charge par Doxygen.

    Pour cacher les membres privés, vous changez Doxyfile fichier de configuration comme suit:

    EXTRACT_PRIVATE        = YES

    Beaucoup d'autres options peuvent être définies pour les différents types d'extraction/masquer des éléments de code, par exemple, en citant Doxyfile lui-même:

    # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
# documentation are documented, even if no documentation was available. 
# Private class members and static file members will be hidden unless 
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

EXTRACT_ALL            = YES

# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
# will be included in the documentation.

EXTRACT_PRIVATE        = YES

# If the EXTRACT_STATIC tag is set to YES all static members of a file 
# will be included in the documentation.

EXTRACT_STATIC         = YES

# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
# defined locally in source files will be included in the documentation.
# If set to NO only classes defined in header files are included.

EXTRACT_LOCAL_CLASSES  = YES

# This flag is only useful for Objective-C code. When set to YES local
# methods, which are defined in the implementation section but not in
# the interface are included in the documentation.
# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  = YES

# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base
# name of the file that contains the anonymous namespace. By default
# anonymous namespace are hidden.

EXTRACT_ANON_NSPACES   = NO

# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
# If set to NO (the default) these members will be included in the
# various overviews, but no documentation section is generated.
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
# If set to NO (the default) these classes will be included in the various
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
# friend (class|struct|union) declarations.
# If set to NO (the default) these declarations will be included in the
# documentation.

HIDE_FRIEND_COMPOUNDS  = NO
  2. 13

    Découvrez l' @cond drapeau pour doxygen. En C#, je me cache dans certains de nos cryptage de mot de passe des membres comme ceci:

        //! @cond
    private const String ENCRYPTEDFLAG = "xxxENCFLAGxxx";
    private const String SEED = "hi_i_r_@_seed";
    //! @endcond

    La documentation doxygen voudraient vous faire croire que vous avez besoin d'un conditionnel symbole défini à doxygen et utilisé sur l' @cond ligne, mais cela ne fonctionne pas pour moi. Cette méthode n'.

  3. 8

    Cela fonctionne pour moi, de se cacher, de gros morceaux de code et de la documentation:

    /*! \cond PRIVATE */
<here goes private documented source code>
/*! \endcond */

    Courir avec ENABLED_SECTIONS = PRIVATE pour créer votre version interne de la documentation. Vous pouvez avoir plusieurs conditions et d'activer/de désactiver la fonction de l'auditoire.

    À cacher qu'une partie d'un bloc de documentation, utilisez \internal (va se cacher jusqu'à la fin du bloc, à moins que \endinternal)

    Remarque: vous pouvez utiliser la notation @ si vous le préférez plus de barres obliques inverses.

  4. 3

    Quelques possibilités, allant de l' Doxygen manuel:

    HIDE_UNDOC_MEMBERS, HIDE_UNDOC_CLASSES: de toute Évidence ne fonctionne que si vous avez seulement des membres du public.

    INTERNAL_DOCS: Permet d'utiliser le \internes de balisage pour exclure les commentaires du "public" version de la documentation.

    ENABLED_SECTIONS: Sont plus générales version de INTERNAL_DOCS