Documentación "interna" separada de "externa" en doxygen

Question

Quiero documentar una biblioteca con doxygen. La documentación será leída por dos clases de personas: los usuarios, que solo están interesados ​​en la API externa y los desarrolladores que desean ver documentación para todas las funciones/estructuras.

Me gustaría utilizar para separar archivos doxyfiles para crear la documentación. ¿Hay alguna "etiqueta" que pueda poner en un bloque de comentarios para marcar un comentario como interno/externo?

Answer 1

Conjunto INTERNAL_DOCS:

# The INTERNAL_DOCS tag determines if documentation 
# that is typed after a \internal command is included. If the tag is set 
# to NO (the default) then the documentation will be excluded. 
# Set it to YES to include the internal documentation. 

INTERNAL_DOCS   = NO 

En la documentación, puede utilizar \internal o @internal en cualquier granularidad que desee (archivo, función, etc.).

Answer 2

Utilice el comando \ cond:

\internal (@internal) solamente tiene granularidad para el bloque de comentario actual. No se le permite a ningún modo de ocultar una definición de estructura en C.

La forma más sencilla de hacerlo es poner

\ cond INTERNO

en la parte superior de un archivo de cabecera interna y

\ endcond

en la parte inferior. A continuación, en el archivo de configuración, se agrega

ENABLED_SECTIONS = INTERNO

para permitir que los elementos internos que se incluirán en la documentación.

De esta manera también es recomendado por los usuarios de Doxygen, p. here

Answer 3

Esta es una solución simple que hace uso del hecho de que generalmente puede distinguir las partes internas y externas de su código en archivos.

Usted puede simplemente limitar los archivos de entrada sólo a aquellos ficheros de cabecera que desea exponer en la documentación externa:

# For internal, we parse all files 
INPUT = ./ 
# For external, we parse only the files containing the public interface 
INPUT = include/header1.hpp include/header2.hpp 

Esto tiene la ventaja de que los archivos de origen no tienen que ser modificado (con \internal o @internal).