Doxygen генерирует «человека», но без поля SYNOPSIS

Я настроил свой Doxygen для анализа сценариев Bash (.sh). Я вывожу man файлов.

Единственная проблема в том, что я не знаю, как добавить SYNOPSIS. Эта линия всегда присутствует у человека с Linux, и я хотел бы использовать это, но я не знаю, как это сделать.

Кто-нибудь знает, как я могу этого добиться?


bash shell doxygen manpage
person Housni    schedule 06.12.2015    source источник
comment
У Doxygen есть возможность написать синопсис слова при создании справочной страницы. При создании справочных страниц из кода C я вижу тег SYNOPSIS на справочной странице. Я думаю, что в настройке сценариев bash отсутствуют некоторые части. См. также в Интернете некоторые инструменты преобразования, поищите doxygen bash, хотя, вероятно, не так много о справочных страницах. Когда вы настроили doxygen, также взгляните на код в mangen.cpp, чтобы увидеть, что конвертируется. Я думаю, что метод, предложенный @sifferman, - это просто обходной путь.   -  person albert    schedule 08.12.2015

Ответы (1)


arrow_upward
0
arrow_downward

Вы можете создать свою собственную команду SYNOPSIS, отредактировав Doxyfile и изменив тег ALIASES = для чтения

ALIASES = "synopsis=@par SYNOPSIS\n"

При этом вы можете поместить команду @synopsis (или \synopsis) в документацию, что приведет к созданию пользовательского абзаца с заголовком

ОБЗОР

Как указано в документации doxygen для тега ALIAS, вы можете поместить \n в в части значения псевдонима для вставки новых строк.

person sifferman    schedule 06.12.2015
comment
Обратите внимание, что из-за изменений в теге ALIASES вы должны использовать ^^ вместо \n. - person albert; 16.12.2018