2017-06-29 26 views
2

私はjenkins global libraryを持っており、それを文書化したいと思います。私はgroovydocを使いたい。jenkinsグローバルライブラリからgroovydocを生成する方法

ライブラリがクラスをクラスとグローバルVARS

src/<package-name> 
vars 

の生成ドキュメントが含まれていますが問題ありません:

groovydoc -sourcepath src -d doc 'main.pipeline' '*.groovy' 

しかし、どのように私はVARSのドキュメントを生成することができますか?

答えて

1

現時点で同じ問題がありましたが、悲しいことに私の解決策を試すことはできませんが、srcvarsの両方を含むディレクトリをsourcepathとして使用してみてください。そして、あなたは、このようなあなたのコマンドであなたのsrcvarsサブディレクトリを参照することができます。

groovydoc -sourcepath [PATH_TO_YOUR_LIB] -d doc src\ vars\ 

をそのdoesntの仕事は、多少のように別々にそれぞれのパッケージを参照しようとした場合:

また
groovydoc -sourcepath [PATH_TO_YOUR_LIB] -d doc src\org.foo.some_package src\org.foo.some_other_package vars\ 

、または回避策として、 IntelliJ IDEとその "Generate GroovyDoc ..."を使用することができます - ツール:

  1. IntelliJを起動してGroovyプロジェクトを開きますありえないメニューバーTools > Generate GroovyDoc...
  2. から既存の1)
  3. は()srcvarsの両方を含むInput directoryとしてあなたジェンキンスパイプラインのライブラリを含むソースパスを選択し、Output directory
  4. 押しStart
  5. GroovyDocがあるべきように任意のパス指定されたOutput directory
+0

出力は完全に使用できません。共有ライブラリの構造は標準のグルーヴィーではありません。たとえば、/ varsのファイルはクラスではなく、ファイルにリストされたメソッドだけです。 – herm

関連する問題