固定壊れたパスASDoc?

StackOverflow https://stackoverflow.com/questions/934176

  •  06-09-2019
  •  | 
  •  

質問

この問題の懸念を用いASDocをドキュメンテーションAS3.私はこれからフレックスまたは何かのコマンドを使用して、かなものも動作し、ASDocとならないエラーのリンクによるドキュメンテーションのすべて破となりました。

具体的には、すべての場所にあるコンテンツにリンクしているプロパティやメソッドの他の書類を含む同じクラス）、リンク巻倍増のフォルダーに対応するソフトウェアによるものです。

例えば、なんて言われちゃ記録 myPackage.MyClass.の場合 MyClass プロパティを持ってという MyProperty, は、どこか私のdocsい線のようになります:

@see #MyProperty

そのドキュメントをパースできないバグを修正及び"参照:"リンクが正しく作成され、その巻きつ 

.../output_directory/myPackage/myPackage/MyClass.html#MyProperty

が、実際のファイルシステムが myPackage フォルダにまとめた。

に関連する部ASDocコマンドは以下のようなものです:

asdoc
 -source-path .
 -doc-sources myPackage
 -output D:\dev\repository\docs\myPackage_docs
 -external-library-path "C:\Progra~1\Adobe\flex_sdk_3\frameworks\libs\player\10\playerglobal.swc"

私も欠かASDoc引数が指定のベースURLリンクの違いによるものなのか、それともされるようになってい?このた平野のバグでは明らかに多く出すことはできなかったが気を集めるポタジエがgoogleの課題であり、私の作業仮説となる人運ASDocからフレックスかの設定んを省略する。

させます。

の提案TypeOneErrorう異なる種類の@参照リンクになります。いであることを明らかにした作:

  • @see some.package
  • @see ClassName
  • @see ClassName#property

これら働いていない方は:

  • @see #property
  • @see full.package.ClassName
  • @see full.package.ClassName#property

何が少し悪いですが、すべての航行のリンクを、同じ倍増経路が自動的に発生するタイプのリンクです。例えば、この各メソッドの署名の場合、メソッドが返すクラスの文書、リンクが壊れています。

また、HTML、この問題が表示されていないのページのベースURLは何か矛盾したリンクです。で連続の連続 @see リンクは、リンク ClassName.html 一部へのリンク package/ClassName.html, のルールを上記に示します。すべてのことにより、ビジネスマンが集まるのですがtrueかどうかにかかわらずページで見たフレームです。

詳細情報がフィギュアいものの、アイデアのための回避策が最も大歓迎です。

更新: 数の詳細:私のプレの設定顔は丸の正確なアプリケーションを素早く除を伴うフレックス3が実行しASDoc引数がなければ、報告します: Adobe ASDoc Version 3.3.0 build 4852.私はこのすべてのWindows XPから、バッチファイルをclasspathをクリックします。

部分的に解決: すべてのものは、私の問題解決へのアップグレード4.0.0.7219版βリリースのフレックス4SDK（利用のASDoc分散、及びそれに).現在、すべての私 @see タグ作品として期待される。そして残された問題は、どこしている方法を返しまうクラスの文書、ASDocでmanglesます。例えば、い方法が署名 ClassA#getB():ClassB, その場でのドキュメント、テキスト"ClassB"へのリンク"packageName:ClassB.html"の代わりに"packageName/ClassB.html".このように見ることで、単なるバグ。Bleh.

役に立ちましたか？

解決

のASDocはありません最後にイライラさせられます。あなたが@seeに完全なパッケージ/クラス名を追加し、明示的にしようとしたことがあり、すなわちます：

@see myPackage.myClass#MyProperty

それは違いを作るかどうかを確認するには？

編集

私はあなたの知見に基づいていくつかのテストを実行し、内部プロパティマーカーは私のために働いています。すなわちます。

@see #_dispatcher

直接ページでそのプロパティ（なしダブルサブフォルダ）へのリンク。私は多分あなたがコマンドを実行している方法を再考する必要があると思います。例えば、私のコードベースは以下のようなものを設定されます：

/src
    /com
        /bkwld
            /fetch

私は一般的に "SRC" 内部のASDocを実行します：

asdoc -source-path . -doc-classes com/bkwld/fetch/Fetch

私はFetch.asにこれらのすべてを試してみましたが、それらはすべて期待通りに働いています：

*  @see FetchItem
*  @see com.bkwld.utils.Logger
*  @see #_dispatcher

は、まず第二の異なるパッケージにロガーのページへ連れて行ってくれた、そして第三取得の保護方法にページをジャンプアップ。

、FetchItemページに連れて行ってくれました

ただ、好奇心から...あなたは、SDKのバージョンを使用していますか？

他のヒント

私は推測するだろう問題は、あなたのラインです。

-doc-源mypackageと

を指定します ''そこの代わりに「mypackageと」それは（そう、あなたのソースパスにそれを同一に）

固定する必要がありますの

Iが誤っ上記に述べた場合のASDocによって生成された経路を固定する単純なPythonスクリプトを書きました。つまり、メソッドMyMethodは存在する場合（V：MyClassの、...） ASDocのは間違ってリンクのhref = "：MyClassの../ mypackageと" を生成します スクリプトは置き換え、これを修正します：/

により、

私はかなり「フラット」構造を持って生成していますドキュメントは、それは、クラスの束を持つ単一のパッケージであることに気付くはずです。修正プログラムは、より複雑な文書構造で動作する場合、私は考えている。

誰もがスクリプトを試してみたい場合は、

とにかく、私はそれを送信するために喜んでいるよ。

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top