summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYusuke Endoh <mame@ruby-lang.org>2019-08-08 17:34:50 +0900
committerYusuke Endoh <mame@ruby-lang.org>2019-08-08 17:36:12 +0900
commit20cb8e8aeab916d659c0359a35687bb8df1f31a6 (patch)
tree732de0e8d276857b544088a406c57c5bfa73feca
parentb39efb163dd97a6b2c92cac3d2b1c19f898d0c04 (diff)
main.c: Add doxygen mainpage
The document is experimentally produced in: https://rubyci.s3.amazonaws.com/doxygen/modules.html
-rw-r--r--main.c8
1 files changed, 8 insertions, 0 deletions
diff --git a/main.c b/main.c
index 6e8ab7b..313aaed 100644
--- a/main.c
+++ b/main.c
@@ -9,6 +9,14 @@
**********************************************************************/
+/*!
+ * \mainpage Developers' documentation for Ruby
+ *
+ * This documentation is produced by applying Doxygen to
+ * <a href="https://github.com/ruby/ruby">Ruby's source code</a>.
+ * It is still under construction (and even not well-maintained).
+ * If you are familiar with Ruby's source code, please improve the doc.
+ */
#undef RUBY_EXPORT
#include "ruby.h"
#include "vm_debug.h"