Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simpler documentation #2984

Merged
merged 13 commits into from Oct 8, 2015
Merged

Simpler documentation #2984

merged 13 commits into from Oct 8, 2015

Conversation

@sagmor
Copy link
Contributor

sagmor commented Oct 8, 2015

Hi,

Keeping up with my documentation efforts (#2959) I worked on a better/simpler approach to documenting mruby.

Here I left everything ready to be documented using a YARD plugin tailored for mruby projects (yard-mruby).

To generate the docs all it's needed is the yard-mruby gem and executing the mrbdoc command (which applies to generating mrbgem docs too).

Here the docs get generated at doc/api and already merged all the docs already at doc/api into their respective header. and moved all other files in doc into doc/guides

You can take a look at the generated docs at http://sagmor.com/mruby to get an idea of the end result and soon will be pushing a PR for mruby.org website

MRB_API mrb_bool mrb_obj_respond_to(mrb_state *mrb, struct RClass* c, mrb_sym mid);
MRB_API struct RClass * mrb_define_class_under(mrb_state *mrb, struct RClass *outer, const char *name, struct RClass *super);
MRB_API struct RClass * mrb_define_module_under(mrb_state *mrb, struct RClass *outer, const char *name);
MRB_API mrb_bool mrb_obj_mrb_define_class_underrespond_to(mrb_state *mrb, struct RClass* c, mrb_sym mid);

This comment has been minimized.

Copy link
@furunkel

furunkel Oct 8, 2015

Contributor

mrb_obj_mrb_define_class_underrespond_to seems to be a typo ?

@sagmor sagmor force-pushed the sagmor:yard branch from 810d2a5 to 87e0840 Oct 8, 2015
@sagmor
Copy link
Contributor Author

sagmor commented Oct 8, 2015

@furunkel Thanks for the headsup! fixed

matz added a commit that referenced this pull request Oct 8, 2015
Simpler documentation
@matz matz merged commit 02a6d86 into mruby:master Oct 8, 2015
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@tsahara tsahara mentioned this pull request Oct 20, 2015
68 of 69 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.