标签: documentation

我在我的评论块中使用了 @remarks 和 @ingroup，但是当我运行 Atomineer 时，它一直将它们标记为删除，我不知道如何防止它这样做。我查看了 .XML 配置文件中的修改规则，但我显然遗漏了一些东西。

使用 Atomineer 处理之前的示例：

//-------------------------------------------------------------------------------------
/// @copydoc interface_Result
///          
/// @ingroup platform_implementation module_core
//-------------------------------------------------------------------------------------

使用 Atomineer 处理后的示例：

//------------------------------------------------------------------------------------
/// @copydoc interface_Result.
///
/// ### ingroup platform_implementation module_core.
//------------------------------------------------------------------------------------

文档说：“设置您的 Doxygen 或 DocXML 模板，以指示新评论格式中的‘合法’条目，以及它们在新评论块中的排序方式。在旧格式和新格式中具有相同标签的任何条目（例如 param -> param）将自动“转换”（以新样式重新格式化）。任何不被 AtomineerUtils 视为“合法”的条目都将被标记为“已删除”，并带有 ### 前缀。”

任何指针或想法将不胜感激？我真的需要它来停止这样做。

谢谢！

如果我有一个这样的 XML 文档：

<people>
    <person>
        <name> Mario </name>
        <age> 25 </age>
    </person>
    <person>
        <name> Lucas </name>
        <age> 32 </age>
    </person>
</people>

是否总是保证在文档顺序中，Mario 出现在 Lucas 之前？所以卢卡斯始终是马里奥的追随者，还是依赖于实现？

我正在使用 Jekyll 和 GitHub Pages 为位于 GitHub 中组织帐户一部分的单独存储库中的项目创建文档。我的团队决定将文档与代码一起放在每个存储库中最有意义，因此我们将在每个存储库中使用 gh-pages 分支。

我还将从组织帐户中设置一个单独的 gh-pages 存储库作为登录页面。我想让我所有的 jekyll 配置项都存在于这个 repo 中。我需要在每个存储库的配置文件中放入什么才能从这个中心位置成功提取所有布局、css/scss 等？这甚至可能吗？

这是一个视觉表示

简而言之，我试图有一个地方可以更改网站格式文件，而不是 6。

我有以下类,一个隐藏(或阴影)内置函数的方法.我希望文档包含一个"另请参见"部分,该部分链接到隐藏的内置函数.

classdef CatHelper
  %CATHELPER Makes implementing vertcat/horzcat easy on a custom class
  %
  %   See Also: cat

  methods (Abstract)
    obj = cat(obj, ndim, varargin);
  end
end

不幸的是,"see also"链接只是尝试在未记录的抽象方法上提供帮助CatHelper/cat.

如何指定我希望链接转到内置 cat函数？

我尝试编写我的第一个R包并启动一个测试功能.当我创建一个全新的包时,我在R文件夹中得到一个示例'Hello.R',在Man文件夹中得到'Hello.Rd'.

然后我删除helloworld测试函数并输入我的测试代码,编写文档并尝试创建一个新文档:

#' A Cat Function
#'
#' This function allows you to express your love of cats.
#' @param love Do you love cats? Defaults to TRUE.
#' @keywords cats
#' @export
#' @examples
#' cat_function()

cat_function <- function(love=TRUE){
  if(love==TRUE){
    print("I love cats!")
  }
  else {
    print("I am not a cool person.")
  }
}

devtools::document()

然后我收到了这个错误:

> devtools::document()
Updating cat2 documentation
Loading cat2
First time using roxygen2. Upgrading automatically...
Updating roxygen version in /Users/daisywang/Desktop/R Package          Programming/cat2/DESCRIPTION
Warning: The existing …

假设我有一个更高阶的函数,它注册了某种点击监听器.我可以记录它的用途和listener传入的参数,如下所示:

/**
 * Adds a [listener] that's called when the item is clicked.
 *
 * @param listener The listener to add
 */
fun addClickListener(listener: (count: Int) -> Unit) {
    ...
}

我的问题是,有没有办法记录参数listener？这将是count在这个例子中.在我的实际用例中,我的监听器中有多个参数.

我注意到的是[listener]文本可以在我正在使用此功能的文档视图中单击,但它只显示一个关于它的空对话框.有没有办法以某种方式描述参数？

现在,我最终@param在addClickListener方法中用块来描述侦听器的参数,但这会在IDE中产生警告,我想知道是否有更合适的方法来执行此操作.

我正在尝试使用try按钮制作一个html。swagger-code gen或swagger-ui都给了我这个结果。你有什么建议吗？

Rust的这部分内容似乎暗示可以将Rust文档保存在单独的.md文件中，但是没有说明如何将这些.md文件重新包含在内。这是如何运作的？

我知道Golang通过以功能名称（拼写为“ func”）开头的单行注释来支持功能文档。但是，这有一个令人作呕的副作用：具有多个单行注释将不会生成带有换行符的GoDoc，该换行符将文本的每一行分开

这是一张图片来说明：

这是函子及其文档：

//GetFunctionName gets function name
// Parameters:
// - `i` : Function
// **NOTE** this func fails if `i` is a variable set to a func
// (they're called "anonymous functions" in JavaScript)
func GetFunctionName(i interface{}) string {
    return runtime.FuncForPC(reflect.ValueOf(i).Pointer()).Name()
}

如何在生成的文档中插入换行符？（如果这是Javadoc，我希望<br>一切都会很好）

如何为混合项目生成文档？怎么做呢？

使用Elixir混合项目的过程：

• 我通过mix new greeter命令生成一个项目。
• 我在greeter.ex文件中添加了一块注释。
• 我将依赖项添加到mix.exs文件中。
• 我尝试通过mix docs 命令生成文档。

mix help 无法docs在可能的选项列表中提供任务：

mix                   # Runs the default task (current: "mix run")
mix app.start         # Starts all registered apps
mix app.tree          # Prints the application tree
mix archive           # Lists installed archives
mix archive.build     # Archives this project into a .ez file
mix archive.install   # Installs an archive locally
mix archive.uninstall # Uninstalls archives
mix clean             # Deletes generated application files …