最好的方式说doxygen“不解析\代码部分”?

时间:2016-11-23 17:36:29

标签: markdown doxygen

Doxygen版本1.8.12 为什么在.md(markdown)文件中我的代码块中有@param,@ example的行?如何防止这种情况?

示例:

Before code text...
~~~~{.php}
namespace ModuleName\Model\ExternalApi\News;
class getList extends \ExternalApi\Model\AbstractMethods\AbstractGetList
{
    ...

    /**
    * Описание метода для справки на русском языке
    * #lang-en: Method description in English
    * #lang-de: Beschreibung des Verfahrens in Deutsch
    *
    * @param string $token Авторизационный токен
    * #lang-en: Authorization token
    * #lang-de: Autorisierungs-Token
    *
    * @param string $param1 Произвольный параметр
    * #lang-en: Custom option
    * #lang-de: Benutzerdefinierte Option
    *
    * @example 
    * GET /api/methods/news.getList?token=abcd&param1=1234
    * <pre>
    * {
    *    "response": {
    *        "news": [
    *            {
    *                "id": 1,
    *                "title": "Заголовок новости 1"
    *            },
    *            {
    *                "id": 2,
    *                "title": "Заголовок новости 2"
    *            },
    *        ]
    *    }
    * }
    * </pre>
    *
    * @return array массив со списком новостей. Описание ключей
    * response.news.id - ID новости
    * response.news.title - Название новости
    *
    * #lang-en: Array of news. Keys descriptions:
    * response.news.id - ID of news
    * response.news.title - Title of news
    *
    * #lang-de: Array von Nachrichten. Tastenbeschreibungen:
    * response.news.id - ID der Nachrichten
    * response.news.title - Titel der Nachrichten
    */
    protected function process($token, $param1)
    {
        //...
    }
}
~~~~

我想看看这个代码块没有对结果文档进行任何更改,这是真的吗?

0 个答案:

没有答案