Obtención de referencias a shared_ptr aparecen en los diagramas de colaboración doxygen

Question

que he hecho lo suficiente buscar en Google para saber que si tengo algo como

class SubObject { 

public: 
//blah blah blah 
}; 

class Aggregate { 
public: 
    boost::shared_ptr<SubObject> m_ptr; 
}; 

puedo conseguir Doxygen para crear el diagrama de colaboración "correcta" si tengo una declaración ficticia como

namespace boost { template<class T> class shared_ptr { T *dummy; }; } 

en mi archivo de cabecera.

Mi pregunta es: ¿cómo hago para que funcione con todos mis proyectos y todos mis encabezados, sin tener que incluir realmente esa línea en cada archivo?

Answer 1

Je .... me siento estúpida responder a mis propias preguntas, pero la forma de saberlo prácticamente justo después de publicar que:

Ponga el fragmento de código

namespace boost { template<class T> class shared_ptr { T *dummy; }; } 

en un fichero de cabecera, llamado algo así como "doxygen_dummy.h", y asegúrese de que esté incluido en el espacio de trabajo o directorio de su proyecto. No es necesario que realmente # lo incluyan en ninguna parte (de hecho, no lo desea, para evitar violar la Regla de una sola definición). Solo necesita que Doxygen pueda verlo cuando escanea todos sus archivos.

Answer 2

Gracias Eric, eso funcionó. Sin embargo, no me gustaron las clases dummy adicionales que ampliaron mis diagramas de colaboración, así que me preparé un poco más. Esta configuración de Doxyfile cambia todo el código boost :: smart_ptr a T *. Esto omite el smart_ptr y crea un enlace directo al tipo en el diagrama de colaboración.

INPUT_FILTER = "sed 's/boost::shared_ptr<\(.*\)>/\1*/'" 

Esto probablemente no es lo que quiere para documentos finales, ya que lo que realmente hace ocultar todas las referencias a smart_ptr como puntero sencillo, pero los diagramas de colaboración se vuelven mucho más legible.

Answer 3

La pregunta puede estar desactualizada pero probé la solución de MattiasF que no era perfecta (no culpo).

IMO, utiliza un encabezado doxygen_dummy en una solución no adecuada para shared_ptr. La clase shared_ptr es solo un propósito de administración de memoria y seguramente no es necesaria en la documentación de Doxygen.

En el trabajo, uso un INPUT_FILTER con sed. Me parece un buen patrón (MEM :: es un alias de espacio de nombres):

INPUT_FILTER = "sed -e \"s/mem::shared_ptr<\([a-zA-Z0-9_]*\)> /\1* /g\" -e \"s/mem::shared_ptr<\(.*\)> /\1* /g\"" 

El primer patrón coincide con todas shared_ptr con plantillas simples, es decir, un tipo sin plantilla. El segundo patrón coincide con el resto de las plantillas shared_ptr independientemente del tipo complejo (con plantilla).

He encontrado un inconveniente: el nombre completo como plantilla, que incluye '::', aún no se maneja. La solución, aún no lo he hecho, es agregar un "personaje" :: en el primer patrón de sed.