2012-04-02 3 views
0

ここにDoxygen noobがあります。私は検索し、何時間もこれを解決するように努力しました。その答えは、私が見慣れていないほど明白ではないようです。doxygen @parコマンドが壊れていて、紛失したhtml出力<b>またはエラー</b>タグ

EDIT:doxygenの@parコマンドは、いずれかの方法で<dt><b>を挿入するために失敗、または</dt>内の誤った</b>を挿入することにより、(GUIウィザードを経由してdoxy 1.8.0を実行している)HTML出力ページを破り、同様のコマンドしばらく(例えば、@return@noteのように)そうではありません。例のコメント(これは重要な場合はコメントが...、機能上です):

/** 
Register a new exit to the room object. Adds the exit to our exit_hash map with some safety checks for whether we've been passed an array of exits or just one. 

New practice; there's now an exit hash map ([direction:hash]) 
and we add exits into our hash map as they're created. This is how guards 
are now identified: they're assigned the hashes they guard as IDs. 

@code 
OH JESUS GOD PLEASE WORK 
@endcode 

@return hrm 

\note 
This note consists of two paragraphs. 
This is the first paragraph. 

\par User defined paragraph: 
Contents of the paragraph. 

\par 
New paragraph under the same heading. 

\par 
And this is the second paragraph. 

More normal text. 


*/ 

私は、コマンドの使用方法のdoxygenのデモからそれを持ち上げたてきたようにあなたは、コメントの一部を認識することができます。これは、 "This is the first paragraph。"で終了するHTML出力を生成します。 \ノート指揮下に(この前にすべてのセクションが適切にレンダリング)、およびdoxygenをページの上部にエラー引用:

This page contains the following errors: error on line 422 at column 42: Opening and ending tag mismatch: dt line 0 and b Below is a rendering of the page up to the first error.

XMLのレンダリングを(あるいは少なくとも、私には見える)適切かつ次のとおりです。

<detaileddescription> 
    <para>Adds the exit to our exit_hash map with some safety checks for whether we&apos;ve been passed an array of exits or just one.</para> 
    <para>New practice; there&apos;s now an exit hash map ([direction:hash]) and we add exits into our hash map as they&apos;re created. This is how guards are now identified: they&apos;re assigned the hashes they guard as IDs.</para> 
    <para><programlisting><codeline><highlight class="normal">OH<sp/>JESUS<sp/>GOD<sp/>PLEASE<sp/>WORK</highlight></codeline></programlisting></para> 
    <para> 
     <simplesect kind="return"><para>hrm</para></simplesect> 
     <simplesect kind="note"><para>This note consists of two paragraphs. This is the first paragraph.</para></simplesect> 
     <simplesect kind="par"><title>User defined paragraph:</title><para>Contents of the paragraph.</para></simplesect> 
     <simplesect kind="par"><title></title><para>New paragraph under the same heading.</para></simplesect> 
     <simplesect kind="par"><title></title><para>And this is the second paragraph.</para></simplesect> 
More normal text. 
    </para> 
</detaileddescription> 

エラーサイトでHTML出力:私はよく分からないが、あなたの問題の一部は、あなたの\note内の段落の1の段落のタイトルを使用していることかもしれ

<p>Register a new exit to the room object. </p> 
<p>Adds the exit to our exit_hash map with some safety checks for whether we've been passed an array of exits or just one.</p> 
<p>New practice; there's now an exit hash map ([direction:hash]) and we add exits into our hash map as they're created. This is how guards are now identified: they're assigned the hashes they guard as IDs.</p> 
<div class="fragment"><pre class="fragment">OH JESUS GOD PLEASE WORK 
</pre></div><dl class="section return"><dt>Returns:</dt><dd>hrm</dd></dl> 
<dl class="section note"><dt>Note:</dt><dd>This note consists of two paragraphs. This is the first paragraph.</dd></dl> 
<dl class="section user"><dt></b></dt><dd>And this is the second paragraph.</dd></dl> 
<dl class="section user"><dt>User defined paragraph:</b></dt><dd>Contents of the paragraph.</dd></dl> 
<dl class="section user"><dt></b></dt><dd>New paragraph under the same heading.</dd></dl> 
<dl class="section user"><dt></b></dt><dd>And this is the second paragraph.</dd></dl> 
<p>More normal text. </p> 

答えて

0

私は日のためにコメント形式でエラーを検索/オプションをトグルしてきたし、それが見えますDOT_IMAGE_FORMAT設定のドキュメントで推奨されているよう.xhtmlからHTML_FILE_EXTENSIONオプションを設定します。

The DOT_IMAGE_FORMAT tag can be used to set the image format of the images generated by dot. Possible values are svg, png, jpg, or gif. If left blank png will be used. Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files visible in IE 9+ (other browsers do not have this requirement).

この設定は、エラー(バグレポート:https://bugzilla.gnome.org/show_bug.cgi?id=672472)の原因ではありませんが、設定は、それは防ぐことが原因となりましたpペアになっていないタグのために読み込みが行われていないこの設定を.htmlに戻すと、余分な</b>タグの問題は解決されませんが、今のところページを破棄しないようにする回避策として機能します。

1

\par用doxygenをマニュアルページから:タイトルを追加すると、以前のコマンドブロックを終了することを意味

If no paragraph title is given this command will start a new paragraph. This will also work inside other paragraph commands (like \param or \warning) without ending that command.

。ドキュメントを\parのドキュメントの例と一致するように並べ替えて、期待どおりの結果が得られるかどうかを確認してください。

また、422行は何ですか?

私が持っていた:私は最終的に私は他の誰かが見て来る必要があり、ここで文書化するだろう問題を、孤立きたよう

+0

ありがとう、クリス - 私は元の質問をHTML出力で更新しました。私は夢中になっていたし、エラーポイントで単に停止したChromeの要素インスペクタを使用しました。今度は ''が存在しない(そして@ return/@ noteコマンドの書式が与えられていて、まったく間違っていると思われる)''タグが含まれていることがわかりました。何が起こっていますか。 私は、コメントをjava_autodocの簡潔な/詳細な説明と '@ par'文書の例の正確なテキストだけに置き換えましたが、エラーは一貫して表示されます。 – abathur

1

私は同じ状況にあります。 .svgのドット図のために.xhtmlを私の内線番号としてください。あなたが@codeブロックの前後に余分な改行を置けば、多くの問題を解決するように見えることを私が発見した:

/** 
* @par Example: 
* This is an example: 
* 
* @code 
* // Some code 
* @endcode 
* 
* The above example is AWESOME! 
*/ 

/** 
* @par Example: 
* This is an example: 
* @code 
* // Some code 
* @endcode 
* The above example is AWESOME! 
*/ 

以上、私はそれを変更した場合、XHTMLエラーが作成されますが、

もう一度すべてが問題ありません。これはあなたの問題の解決策であるかもしれないし、そうでないかもしれないが、doxygen XHTML出力を回避しながら私の.xhtmlの拡張を維持することを許している。

関連する問題