标签: documentation-generation

如果你有一个被描述为C结构的二进制文件格式(或数据包格式),是否有任何程序可以解析结构并将其转换为协议的简洁文档？

结构当然包含数组,其他结构等,以描述格式.文档可能需要包含诸如打包,字节顺序等内容.

我有跟随pod使用getopt :: long:

=head1 SYNOPSIS

foo [OPTION]... [URL]...

=head1 OPTIONS

=over 20

=item B<-h, --help>

Print a brief help message and exits.

=item B<-i, --input=FILE>

Reads from FILE

=back

=cut

当我提供-h它产生:

Usage:
    foo [OPTION]... [URL]...

Options:
    -h, --help          Print a brief help message and exits.

    -i, --input=FILE    Reads from FILE

我的问题是:如何删除-h和-i之间的空行？

我想使用Yii文档生成器,我已经在protected/commands中提取了源代码.

当我尝试运行命令时:

yiic docs check

它说:

Yii command runner (based on Yii v1.1.8)
Usage: c:\wamp\www\FRAMEW~1\yiic <command-name> [parameters...]

The following commands are available:
 - message
 - migrate
 - shell
 - webapp

To see individual command help, use the following:
   c:\wamp\www\FRAMEW~1\yiic help <command-name>

我是否需要编辑任何配置才能运行docs命令？

使用时编译源代码时csc.exe,可以使用/ doc选项将源文件中的xml文档注释保存到外部xml文件中.

我想知道的是编译器为什么在该文件中包含我的代码的非公共成员的xml注释.由于我已经在源代码中有文档,因此在处理该项目时,我不需要xml文档文件中的任何内容.

如果我将dll用于另一个项目,我无论如何都不能使用非公共成员.那为什么它包含所有私人和内部成员的文档？

我还想知道是否有办法防止这种情况发生.

出于某些原因,我想记录一个API,但我不想直接在源代码中编写文档,因为它现在已经广泛使用.我正在寻找一个文档生成器工具,它可以将文档文件作为输入,并且能够从源代码中获取函数原型并检查与文档的一致性.你知道任何可以做到这一点的工具吗？

是否可以在XCode中为给定方法自动生成文档模板？

文档模板示例:

///  
/// - parameter x: 
/// - parameter y: 
/// - parameter w: 
/// - parameter d: 
/// - returns: T

对应这种方法:

func subface(x: CGFloat, y: CGFloat, w: CGFloat, d: Int) -> UIImage{
    // ...
}

我想了解WebKit(200万行C++代码).我想要一个工具,它将类名作为输入,并告诉我从中继承的所有类的名称.

例如,如果我传入"RenderObject",它应该返回RenderInline,RenderBox.

我正在使用Fedora 13并且出于调试目的而使用QtCreator IDE.

JSDoc似乎没有接受我的大部分功能.这是一个例子:

/**
 * Function one.
 */
(function one() {
    /**
     * Function two.
     */
    function two() {
        /**
         * Function three.
         */
        function three() {
        }
    }
})();

var four = {
    /**
     * Function five/six.
     */
    five: function six() {
    },
    /**
     * Function seven/eight.
     */
    seven: function eight() {
    },
};

nine.ten = {
    /**
     * Function eleven/twelve.
     */
    eleven: function twelve() {
        /**
         * Function thirteen/fourteen.
         */
        var thirteen = function fourteen() {
        };
    },
    /**
     * …

我目前正在Vala写一个图书馆.

我已经到了一点,我想从我的来源生成一些文档.

valadoc 似乎是正确的工具,但没有太多关于如何使用它的信息,手册页很短.

我尝试运行它,valadoc -o doc src/*.{vala,vapi}它给了我这些错误消息:

unixodbc.vala:21.7-21.9: error: The namespace name `Gee' could not be found
unixodbc.vala:40.9-40.27: error: The type name `Map' could not be found
unixodbc.vala:42.30-42.48: error: The type name `Map' could not be found
unixodbc.vala:40.9-40.27: error: The type name `Map' could not be found
unixodbc.vala:40.9-40.27: error: The type name `Map' could not be found
unixodbc.vala:40.9-40.27: error: The type name `Map' could not be found
unixodbc.vala:80.63-80.81: error: The type name `Map' could not be found …

如果我执行命令 grunt docular-server

我收到错误消息:

ERROR: Could not start node server [TypeError: Object #<Object> has no method 'server']

那么docular-server没有运行.

我安装了grunt来编写我的代码文档,如下所示:

 `npm install -g grunt-cli`
 `npm install grunt grunt-docular`

我Gruntfile.js看起来像这样:

module.exports = function(grunt) {

// Project configuration.
grunt.initConfig({

pkg: grunt.file.readJSON('package.json'),

docular: {
groups: [],
showDocularDocs: true,
showAngularDocs: true
}

});

// Load the plugin that provides the "docular" tasks.
grunt.loadNpmTasks('grunt-docular');

// Default task(s).
grunt.registerTask('default', ['docular']);

};

这个例子来自官方网站:

http://grunt-docular.com/documentation/docular/docularinstall/installdocular