簡體   English   中英

為Eclipse插件提供javadoc插件,無源代碼

[英]Providing javadoc plug-in for Eclipse plug-ins without source code

我制作了一個 RCP 應用程序,由 Eclipse RCP 平台和我自己的 ~20 個 Eclipse 插件組成(現在我們將其命名為 SDK)。 現在我需要將這個 SDK 提供給其他開發者,他們將制作插件,使用這個 SDK 來擴展應用程序功能。 因此,我使用 Tycho 構建了插件,並將二進制文件提供給初級人員,以在他們的 IDE 中將其用作目標平台。 但顯然,開發人員在 Eclipse IDE 中看不到 javadoc,這使得他們的工作更加困難。 不幸的是,我無法向他們提供這些包的源代碼,因此提供源包的明顯解決方案是不可接受的。 我可以單獨生成 javadoc 並告訴開發人員在 IDE 中手動附加它,但是插件很多,並且 IDE 不會將 javadoc 附加到所需的捆綁包中。

問題是,一般來說,在沒有源代碼的情況下制作僅 javadoc 包的正確方法是什么,Eclipse IDE 會自動用作 javadoc 源代碼?

我設法創建了插件(如com.acme.sdk.doc ),其中為我的平台生成 javadoc 並使用tycho-document-bundle存儲。 然后我將此插件安裝到 Eclipse IDE 中,我的目標平台已在其中設置,希望在此捆綁包中使用 javadoc 目錄有一些魔力。 這行不通。 然后我讓 tycho 也為 javadoc 生成 TOC,並通過org.eclipse.help.toc擴展點注冊了這個 TOC。 The docs then showed in Eclipse Help, but the Java Editor still says that no javadoc attached, when hovering cursor on the classes from my SDK. 最后嘗試我還使用org.eclipse.pde.core.javadoc擴展點注冊了 javadoc,但這也不起作用。 我也知道這一點是否有任何方法可以自動化 Eclipse 中非 JRE 包的 Javadoc 附件? 類似的問題。 有了 tycho 插件和 PDE 擴展點,我覺得我很接近,只是找不到讓 IDE 識別這個捆綁包的方法。

到目前為止,我發現的唯一方法是為每個平台包生成 javadoc 並將其放在doc目錄中的每個包中 - 這樣 Eclipse IDE 神奇地找到了它。 這里的缺點是我必須構建兩個版本的 SDK:一個用於沒有文檔的生產版本,一個用於開發。

好吧,我想出了問題所在,所以我會自己發布答案。 包含 javadoc 和org.eclipse.pde.core.javadoc擴展定義的插件必須位於記錄插件的同一目標平台中。

之前我把所有的SDK插件都放到了初中IDE的Target Platform,但是包含javadocs的插件放到Z32F7222026696F30787889194Z的dropins目錄下。 IDE 安裝它,幫助貢獻出現,但 PDE 不會解析 javadoc。 一旦我將 javadoc 插件添加到目標平台,解析就開始正常工作。

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM