Skip to content

Conversation

nuclearsandwich
Copy link
Contributor

Using a modified copy of the gen/api script I generated API docs that target version 1.4.1 which is the current release as of this writing.

Below is the output of the documentation generation. I am not sure if the warnings below are expected.

HEAD is now at 023070a6 Set the mruby-1.4.1 release date to `2018-4-27`.
~/code/mruby.github.io
~/code/mruby.github.io/mruby ~/code/mruby.github.io
[warn]: In file `mrbgems/mruby-enum-ext/mrblib/enum.rb':505: Cannot resolve link to ant from text:
        ...{ant bear cat}...
[warn]: In file `(unknown)':849: Cannot resolve link to Class from text:
        ...{Class}...
Files:          68
Modules:         9 (    5 undocumented)
Classes:        63 (   34 undocumented)
Constants:      27 (   27 undocumented)
Attributes:     15 (    0 undocumented)
Methods:       776 (  195 undocumented)
 70.67% documented
~/code/mruby.github.io

Using a modified copy of the gen/api script I generated API docs that target version 1.4.1.
Below is the output of the documentation generation. I am not sure if the warnings below are expected.

    HEAD is now at 023070a6 Set the mruby-1.4.1 release date to `2018-4-27`.
    ~/code/mruby.github.io
    ~/code/mruby.github.io/mruby ~/code/mruby.github.io
    [warn]: In file `mrbgems/mruby-enum-ext/mrblib/enum.rb':505: Cannot resolve link to ant from text:
            ...{ant bear cat}...
    [warn]: In file `(unknown)':849: Cannot resolve link to Class from text:
            ...{Class}...
    Files:          68
    Modules:         9 (    5 undocumented)
    Classes:        63 (   34 undocumented)
    Constants:      27 (   27 undocumented)
    Attributes:     15 (    0 undocumented)
    Methods:       776 (  195 undocumented)
     70.67% documented
    ~/code/mruby.github.io
@matz matz merged commit ed658d2 into mruby:master May 12, 2018
@matz
Copy link
Member

matz commented May 12, 2018

Thank you!

@nuclearsandwich nuclearsandwich deleted the generate-1.4.1-api-docs branch May 12, 2018 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants