Simpler documentation #2984

Merged
merged 13 commits into from Oct 8, 2015

Conversation

Projects
None yet
3 participants
@sagmor
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

include/mruby.h
-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.

@furunkel

furunkel Oct 8, 2015

Contributor

mrb_obj_mrb_define_class_underrespond_to seems to be a typo ?

@furunkel

furunkel Oct 8, 2015

Contributor

mrb_obj_mrb_define_class_underrespond_to seems to be a typo ?

@sagmor

This comment has been minimized.

Show comment
Hide comment
@sagmor

sagmor Oct 8, 2015

Contributor

@furunkel Thanks for the headsup! fixed

Contributor

sagmor commented Oct 8, 2015

@furunkel Thanks for the headsup! fixed

@sagmor sagmor referenced this pull request in mruby/mruby.github.io Oct 8, 2015

Merged

Updated API docs #25

matz added a commit that referenced this pull request Oct 8, 2015

@matz matz merged commit 02a6d86 into mruby:master Oct 8, 2015

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@tsahara tsahara referenced this pull request in iij/mruby Oct 20, 2015

Closed

make December 2015 Stable Release #155

68 of 69 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment