Попытка документировать двумерные объекты, связанные с doxygen - PullRequest
Новая
       32

Попытка документировать двумерные объекты, связанные с doxygen

1 голос
/ 17 февраля 2011

Я работаю над некоторым 2D-кодом геометрии, в частности, над линейным классом.Я сделал enum для описания отношения линии (не будем вдаваться в подробности по этому поводу).Однако, чтобы документировать это, у меня есть что-то вроде этого: 

enum enumRELATION {

   /*!this line  #######
    * other line -------
    *                   
    *     |             
    *  #######          
    *     |             
    *     |             
    */
   RELATION_INTERSECT,

   ...

};

Если я позволю doxygen проанализировать этот файл, чтобы сгенерировать HTML-файл, в HTML-файле это выглядит как дерьмо (конечно).Другими словами, 2D-плоскость, которую я пытаюсь показать, неверна.Я знаю, что могу использовать <br>, чтобы хотя бы получить разрывы строк, но это только половина дела, потому что пробелы все еще не правильные.И <br> делает мою документацию в реальном файле исходного / заголовочного файла ужасной.Есть ли хороший способ обойти это?Или я слишком требовательный?

1 Ответ

1 голос
/ 17 февраля 2011

Вы можете окружить свою документацию элементом ... , который должен хорошо сохранять разрывы строк и отступы.

pre - это один из тегов HTML, который можно безопасно использовать в документации Doxygen, согласно этой странице: http://www.doxygen.nl/manual/htmlcmds.html

Кроме того, вы можете встраивать изображения в документацию, используя команду \ image: http://www.doxygen.nl/manual/commands.html#cmdimage

Я считаю, что использование правильных изображений может сделать документацию более понятной, чем использование 'ascii art';)

...