このブログは、旧・はてなダイアリー「檜山正幸のキマイラ飼育記 メモ編」(http://d.hatena.ne.jp/m-hiyama-memo/)のデータを移行・保存したものであり、今後(2019年1月以降)更新の予定はありません。

今後の更新は、新しいブログ http://m-hiyama-memo.hatenablog.com/ で行います。

DoxygenのMarkdownインラインマークアップ

Markdown形式のインラインマークアップはうまくいかないことが多い。期待しないことにしよう。

  • ネイティブコマンド \b と HTMLタブ <b> は等価。
  • ネイティブコマンド \em と HTMLタブ <em> は等価。
  • ネイティブコマンド \p, \c と HTMLタブ <tt> は等価(タイプライター体)。
  • ネイティブコマンド \n と HTMLタブ <br> は等価。

よって、HTMLタグ b, em, tt, br を使うことにする。。<b>はセマンティックじゃないが、strongの意味として使う。見た目の感じから b > em の順で使おう。

他に、

  • インラインのコード範囲はバッククォートが使える。
  • インラインのURL参照は <URL> が使える。

次の文字はエスケープが必要。

  1. \\
  2. \@
  3. \& HTML実体参照と誤解するから
  4. \<
  5. \>

逆の不等号 > もエスケープする必要がある。以下はDoxygenが使っている特殊文字

  1. \$
  2. \#
  3. \%

エスケープはけっこう忘れる。エラーではないので、間違い検出が難しい。