documentation-generation

7熱度

1回答

Doxygen似乎是C++（和許多其他語言）的代碼文檔的頭號選擇，但每次我從我的手機瀏覽Doxygen生成的文檔時，該網站litteraly不滾動，文本是可怕的小... 怎麼回事？我來自python/sphinx，像readthedocs.org這樣的網站在HTML代（IMO）中管理完美的移動友好性，而最流行的文檔系統卻不能？我肯定錯過了什麼。我試着環視interwebs一段HTML主題最小化

1熱度

1回答

Dox（haxe文檔工具）包概述

有沒有辦法生成什麼Java調用package comments與Dox？

8熱度

1回答

使用配音製作文檔

如何使用配音從我的源文件製作DDoc？在配音中似乎沒有默認命令來做到這一點，我真的希望能夠自動執行此過程。

4熱度

1回答

Java項目文檔（markdown）

我有標準gradle佈局的標準java項目，所有源都存儲在git中。我想用markdown（或類似標記語言）編寫文檔，並將所有文件保存在項目目錄中（例如，文檔/文件夾位於根目錄中）。然後，我想生成靜態網站或將我的源文件推到某處，以便訪問html中的完整文檔（應該是自託管解決方案）。這將是很好，如果我能夠添加簡單的鏈接到其他文章（如我在任何維基引擎通過使用[[article]]）。如果我能夠通過與

0熱度

5回答

Apidocjs文檔創建問題，警告：找不到插件參數解析器並缺少逗號問題

我試圖使用apidocjs創建API文檔，並且在編譯項目時使用apidoc.json在項目文件夾上創建apidoc時出現了問題。代碼在這裏： ~$ apidoc -i ./ -o apidoc/ ，並導致 warning: parser plugin 'param' not found. error: Error: Can not read: apidoc.json, please che

1熱度

1回答

獅身人面像描述有效的輸入值到api

我一直在使用獅身人面像來記錄我們的api。正如人們所預料的那樣，在我們的api中有一些參數值是限制性的。例如，可能有一個用於描述電視的帖子的「開」參數，並且可能有相同的參數用於在GET上進行過濾。我的問題是，我找不到一個內置的方式來描述有效的參數值。對於布爾，我可以把它放在parens中，但有些參數有20個有效的輸入值，有些參數具有多個可能的輸入參數集，具體取決於路徑中多個變量點的值。例如： m

0熱度

1回答

C++文檔：類

創建地圖，我一個C++項目的結構是這樣的：在根文件夾（其中doxygen_config文件包含）一個src文件夾與文件的main.cpp所有的.cpp類文件的包括文件夾中所有的.h類文件即使有，我定義的類之間沒有等級之分（無遺產，沒有接口），是有辦法來創建一個帶有th的UML圖e類以塊的形式打印，還有一些箭頭表示一個類是否是另一個類的成員？我試過Doxygen，但它只創建了一個指示遺產的

0熱度

1回答

擴展jsDoc來處理自定義標籤

我期待擴展jsdoc（特別是docstrap）。我有一個nodeJS應用程序，並希望將jsdoc導航分割爲控制器，視圖等。我已經在一定程度上通過創建我的自定義標籤（如@controller），並設法讓它被類似於@module的JsDoc捕獲，因此它生成頁面（與描述）。然而，我的問題是，當涉及到與例如與'module.exports'功能位於控制器相關的功能。生成的文檔基本上忽略了@control

0熱度

1回答

JSDoc：註解導出的方法

如果我像這樣定義一個對象： /** * My Cool Object * @constructor */ function MyCoolObject() { /** * Cool Method, private * @param {!string} parameter */ function localMethod(para

8熱度

1回答

lodash.com使用哪種文檔生成器

任何想法lodash.com使用的文檔生成器是什麼？我一直在尋找他們的文檔，並使用谷歌，找不到任何東西。我想在我的一個小項目上使用類似的文檔樣式