仅在一行上的doxygen格式不正确

时间:2014-05-29 11:55:09

标签: formatting doxygen

下面C代码中显示的注释块开头的标题在HTML和PDF输出中的格式不正确,为\ verbatim文本。

我在此文件中的所有其他Doxygen注释都完美地工作(它们都非常相似,因为文件提供了符合类型的函数)。

我尝试从文件中删除所有前面的Doxygen注释(@name除外)以排除不正确的块格式化关闭,删除标题规范(#&#39; s)更改标题文本(例如&#34; foo&#34;)如果字符不正确,删除后面的\ verbatim块,删除这个整个注释块本身,看看问题是否转移到下一个,但似乎没有任何改变!! < / p>

如何才能正确格式化标题?感谢。

代码:

/** # *IDN? - Identification query #
 * This query allows the instrument to identify itself. It responds with a `<`string`>` consisting of four fields
 * separated by commas. The four fields are determined by constants defined in the application
 * specific settings in config.h and appear in the following order:
 * \verbatim MANUF,MODEL,SERIAL,FIRMW \endverbatim
 * See the config.h file description for information on each of these fields.
 *
 * @param   parameters  None
 * @param   query       `*IDN?`
 */
extern int16_t IDN (double * parameters, bool query);

PDF格式如何:

how it looks in pdf screenshot

这在HTML中看起来如何:

how it looks in html screenshot

编辑: OPC功能的注释:

/** # *OPC - Operation Complete Command. #
 * This command causes the device to set the operation complete bit in the standard event status register when
 * all pending device operations have completed.
 *
 * The query responds with an ASCII "1" when all pending device operations are complete.
 *
 * @param   parameters  None
 * @param   query       `*OPC?`
 */
extern int16_t OPC (double * parameters, bool query);

1 个答案:

答案 0 :(得分:0)

最后解决了这个问题,尽管我仍然不确定原因。 基本上我一次重写文档注释(我试图看看是否可以隔离导致它的任何一个项目)。 我从一个单词评论开始,当它出现正确时,我慢慢添加更多位,每次添加后重建。我现在有完整的评论,就像以前一样,但现在按预期工作

令人费解......也许doxygen只是在检测到评论被删除并重新开始之后才重建该部分并清除了无论问题是什么?嗯,无论如何都要修好了。感谢您的建议。