Как добавить пробел в комментарии в Doxygen - PullRequest
Новая
       6

Как добавить пробел в комментарии в Doxygen

5 голосов
/ 26 августа 2011

Мне было интересно, есть ли способ вставить пробел в комментарии в HTML Doxygen? Я искал онлайн и руководство по Doxygen, но я не мог найти ничего, чтобы сделать это.

Например, я пытаюсь добавить комментарий следующим образом: 

//!   motor_id,          motor direction,   accel,     min veloc,     max veloc\n
//!   GAUGE_MOTOR_1,     CLOCKWISE,         100,       1,             360\n
//!   GAUGE_MOTOR_2,     CLOCKWISE,         100,       1,             360\n
//!   GAUGE_MOTOR_3,     CLOCKWISE,         100,       1,             360\n
//!   GAUGE_MOTOR_4,     CLOCKWISE,         100,       1,             360\n
//!   GAUGE_MOTOR_5,     CLOCKWISE,         400,       200,           350\n

Но вывод html показывает такой результат 

motor_id, motor direction, accel, min veloc, max veloc
GAUGE_MOTOR_1, CLOCKWISE, 100, 1, 360
GAUGE_MOTOR_2, CLOCKWISE, 100, 1, 360
GAUGE_MOTOR_3, CLOCKWISE, 100, 1, 360
GAUGE_MOTOR_4, CLOCKWISE, 100, 1, 360
GAUGE_MOTOR_5, CLOCKWISE, 400, 200, 350

Пустое пространство между двумя словами будет автоматически сокращено до одного. Кто-нибудь знает, как это исправить? Это очень поможет.

Большое спасибо.

Ответы [ 2 ]

9 голосов
/ 27 августа 2011

Вы можете использовать 

<code>//! <pre>
//!   motor_id,          motor direction,   accel,     min veloc,     max veloc
//!   GAUGE_MOTOR_1,     CLOCKWISE,         100,       1,             360
//!   GAUGE_MOTOR_2,     CLOCKWISE,         100,       1,             360
//!   GAUGE_MOTOR_3,     CLOCKWISE,         100,       1,             360
//!   GAUGE_MOTOR_4,     CLOCKWISE,         100,       1,             360
//!   GAUGE_MOTOR_5,     CLOCKWISE,         400,       200,           350
//!

или 

//! \verbatim
//!   motor_id,          motor direction,   accel,     min veloc,     max veloc
//!   GAUGE_MOTOR_1,     CLOCKWISE,         100,       1,             360
//!   GAUGE_MOTOR_2,     CLOCKWISE,         100,       1,             360
//!   GAUGE_MOTOR_3,     CLOCKWISE,         100,       1,             360
//!   GAUGE_MOTOR_4,     CLOCKWISE,         100,       1,             360
//!   GAUGE_MOTOR_5,     CLOCKWISE,         400,       200,           350
//! \endverbatim

Последний будет действительно отображать текст как есть.Первый по-прежнему позволяет doxygen интерпретировать команды внутри блока, сохраняя при этом пробелы.

0 голосов
/ 15 декабря 2011

В подобных случаях я считаю полезным использовать таблицу HTML и поместить содержимое в отдельный файл. Например, вы можете создать файл с именем «motors.html», поместить его в место, где ваш doxygen сконфигурирован для поиска входных файлов, а затем использовать следующую команду для включения motors.html в ваш исходный код: 

@htmlinclude motors.html

В motors.html у вас может быть что-то вроде следующего: 

<center> 
<table border="0"> 
<tr> 
  <th>motor_id</th> 
  <th>motor direction</th> 
  <th>accel</th> 
  <th>min veloc</th> 
  <th>max veloc</th> 
<tr> 
<tr> 
  <td>GAUGE_MOTOR_1</td> 
  <td>CLOCKWISE</td> 
  <td>100</td> 
  <td>1</td> 
  <td>360</td> 
</tr> 
... 
</table> 
</center>

Вы можете использовать файл CSS для стилизации таблицы.

...