Remove old doxygen tags

mruby · Oct 8, 2015 · a0fe0c4 · a0fe0c4
1 parent 554406b
commit a0fe0c4
Show file tree

Hide file tree

Showing 20 changed files with 41 additions and 119 deletions.
diff --git a/include/mruby.h b/include/mruby.h
@@ -38,9 +38,7 @@
 #include "mruby/version.h"
 
 /**
- * @file mruby.h
- * @defgroup mruby MRuby C API
- * @{
+ * MRuby C API entry point
  */
 MRB_BEGIN_DECL
 
@@ -56,13 +54,13 @@ struct mrb_irep;
 struct mrb_state;
 
 /**
- * Function pointer type of custom allocator used in @ref mrb_open_allocf.
+ * Function pointer type of custom allocator used in @see mrb_open_allocf.
  *
  * The function pointing it must behave similarly as realloc except:
  * - If ptr is NULL it must allocate new space.
  * - If s is NULL, ptr must be freed.
  *
- * See @ref mrb_default_allocf for the default implementation.
+ * See @see mrb_default_allocf for the default implementation.
  */
 typedef void* (*mrb_allocf) (struct mrb_state *mrb, void*, size_t, void *ud);
 
@@ -213,16 +211,17 @@ typedef mrb_value (*mrb_func_t)(mrb_state *mrb, mrb_value);
  * Defines a new class.
  *
  * If you're creating a gem it may look something like this:
- *  <pre>
- *    void mrb_example_gem_init(mrb_state* mrb) {
- *      struct RClass *example_class;
- *      example_class = mrb_define_class(mrb, "Example_Class", mrb->object_class);
- *    }
  *
- *    void mrb_example_gem_final(mrb_state* mrb) {
- *      //free(TheAnimals);
- *    }
- *  </pre>
+ * ```c
+ * void mrb_example_gem_init(mrb_state* mrb) {
+ *   struct RClass *example_class;
+ *   example_class = mrb_define_class(mrb, "Example_Class", mrb->object_class);
+ * }
+ *
+ * void mrb_example_gem_final(mrb_state* mrb) {
+ *   //free(TheAnimals);
+ * }
+ * ```
  *
  * @param name The name of the defined class
  * @param super The new class parent
@@ -676,7 +675,6 @@ MRB_API void mrb_show_copyright(mrb_state *mrb);
 
 MRB_API mrb_value mrb_format(mrb_state *mrb, const char *format, ...);
 
-/** @} */
 MRB_END_DECL
 
 #endif  /* MRUBY_H */
diff --git a/include/mruby/array.h b/include/mruby/array.h
@@ -10,10 +10,7 @@
 #include "mruby/common.h"
 
 /**
- * @file mruby/array.h
- * @defgroup mruby_array Array class
- * @ingroup mruby
- * @{
+ * Array class
  */
 MRB_BEGIN_DECL
 
@@ -58,7 +55,7 @@ MRB_API mrb_value mrb_ary_new_capa(mrb_state*, mrb_int);
  *
  * @param mrb
  *      The MRuby state reference.
- * @returns
+ * @return
  *      The initialized array
  */
 MRB_API mrb_value mrb_ary_new(mrb_state *mrb);
@@ -94,7 +91,7 @@ MRB_API void mrb_ary_push(mrb_state *mrb, mrb_value array, mrb_value value);
  *      The MRuby state reference.
  * @param ary
  *      The array from which the value will be poped.
- * @returns
+ * @return
  *      The poped value.
  */
 MRB_API mrb_value mrb_ary_pop(mrb_state *mrb, mrb_value ary);
@@ -112,7 +109,7 @@ MRB_API mrb_value mrb_ary_pop(mrb_state *mrb, mrb_value ary);
  *      The target array.
  * @param n
  *      The array index being referenced
- * @returns
+ * @return
  *      The referenced value.
  */
 MRB_API mrb_value mrb_ary_ref(mrb_state *mrb, mrb_value ary, mrb_int n);

diff --git a/include/mruby/class.h b/include/mruby/class.h
@@ -10,10 +10,7 @@
 #include "mruby/common.h"
 
 /**
- * @file mruby/class.h
- * @defgroup mruby_class Class class
- * @ingroup mruby
- * @{
+ * Class class
  */
 MRB_BEGIN_DECL
 
@@ -87,7 +84,6 @@ void mrb_gc_mark_mt(mrb_state*, struct RClass*);
 size_t mrb_gc_mark_mt_size(mrb_state*, struct RClass*);
 void mrb_gc_free_mt(mrb_state*, struct RClass*);
 
-/** @} */
 MRB_END_DECL
 
 #endif  /* MRUBY_CLASS_H */
diff --git a/include/mruby/common.h b/include/mruby/common.h
@@ -7,12 +7,6 @@
 #ifndef MRUBY_COMMON_H
 #define MRUBY_COMMON_H
 
-/**
- * @file mruby/common.h
- * @defgroup mruby_common Shared compiler macros
- * @ingroup mruby
- * @{
- */
 
 #ifdef __cplusplus
 # define MRB_BEGIN_DECL extern "C" {
@@ -24,6 +18,11 @@
 # define MRB_END_DECL
 #endif
 
+/**
+ * Shared compiler macros
+ */
+MRB_BEGIN_DECL
+
 /** Declare a function that never returns. */
 #if __STDC_VERSION__ >= 201112L
 # define mrb_noreturn _Noreturn
@@ -63,6 +62,6 @@
 # define MRB_API extern
 #endif
 
-/** @} */
+MRB_END_DECL
 
 #endif  /* MRUBY_COMMON_H */
diff --git a/include/mruby/compile.h b/include/mruby/compile.h
@@ -10,10 +10,7 @@
 #include "mruby/common.h"
 
 /**
- * @file mruby/compile.h
- * @defgroup mruby_compile Compiler
- * @ingroup mruby
- * @{
+ * MRuby Compiler
  */
 MRB_BEGIN_DECL
 

diff --git a/include/mruby/data.h b/include/mruby/data.h
@@ -10,13 +10,9 @@
 #include "mruby/common.h"
 
 /**
- * @file mruby/data.h
- * @defgroup mruby_data Custom C wrapped data.
+ * Custom C wrapped data.
  *
  * Defining Ruby wrappers around native objects.
- *
- * @ingroup mruby
- * @{
  */
 MRB_BEGIN_DECL
 
@@ -74,7 +70,6 @@ mrb_data_init(mrb_value v, void *ptr, const mrb_data_type *type)
   DATA_TYPE(v) = type;
 }
 
-/** @} */
 MRB_END_DECL
 
 #endif /* MRUBY_DATA_H */
diff --git a/include/mruby/debug.h b/include/mruby/debug.h
@@ -10,10 +10,7 @@
 #include "mruby/common.h"
 
 /**
- * @file mruby/debug.h
- * @defgroup mruby_debug Debugging.
- * @ingroup mruby
- * @{
+ * MRuby Debugging.
  */
 MRB_BEGIN_DECL
 
@@ -64,7 +61,6 @@ MRB_API mrb_irep_debug_info_file *mrb_debug_info_append_file(
 MRB_API mrb_irep_debug_info *mrb_debug_info_alloc(mrb_state *mrb, mrb_irep *irep);
 MRB_API void mrb_debug_info_free(mrb_state *mrb, mrb_irep_debug_info *d);
 
-/** @} */
 MRB_END_DECL
 
 #endif /* MRUBY_DEBUG_H */
diff --git a/include/mruby/dump.h b/include/mruby/dump.h
@@ -12,10 +12,7 @@
 #include "mruby/common.h"
 
 /**
- * @file mruby/dump.h
- * @defgroup mruby_dump Dumping compiled mruby script.
- * @ingroup mruby
- * @{
+ * Dumping compiled mruby script.
  */
 MRB_BEGIN_DECL
 
@@ -190,7 +187,6 @@ bin_to_uint8(const uint8_t *bin)
   return (uint8_t)bin[0];
 }
 
-/** @} */
 MRB_END_DECL
 
 /** @internal crc.c */

diff --git a/include/mruby/error.h b/include/mruby/error.h
@@ -10,10 +10,7 @@
 #include "mruby/common.h"
 
 /**
- * @file mruby/error.h
- * @defgroup mruby_error Error handling.
- * @ingroup mruby
- * @{
+ * MRuby error handling.
  */
 MRB_BEGIN_DECL
 
@@ -45,7 +42,6 @@ MRB_API mrb_value mrb_rescue_exceptions(mrb_state *mrb, mrb_func_t body, mrb_val
                                         mrb_func_t rescue, mrb_value r_data,
                                         mrb_int len, struct RClass **classes);
 
-/** @} */
 MRB_END_DECL
 
 #endif  /* MRUBY_ERROR_H */
diff --git a/include/mruby/gc.h b/include/mruby/gc.h
@@ -10,18 +10,14 @@
 #include "mruby/common.h"
 
 /**
- * @file mruby/gc.h
- * @defgroup mruby_gc Uncommon memory management stuffs.
- * @ingroup mruby
- * @{
+ * Uncommon memory management stuffs.
  */
 MRB_BEGIN_DECL
 
 typedef void (mrb_each_object_callback)(mrb_state *mrb, struct RBasic *obj, void *data);
 void mrb_objspace_each_objects(mrb_state *mrb, mrb_each_object_callback *callback, void *data);
 MRB_API void mrb_free_context(mrb_state *mrb, struct mrb_context *c);
 
-/** @} */
 MRB_END_DECL
 
 #endif  /* MRUBY_GC_H */
diff --git a/include/mruby/hash.h b/include/mruby/hash.h
@@ -10,10 +10,7 @@
 #include "mruby/common.h"
 
 /**
- * @file mruby/hash.h
- * @defgroup mruby_hash Hash class
- * @ingroup mruby
- * @{
+ * Hash class
  */
 MRB_BEGIN_DECL
 
@@ -53,7 +50,6 @@ void mrb_gc_mark_hash(mrb_state*, struct RHash*);
 size_t mrb_gc_mark_hash_size(mrb_state*, struct RHash*);
 void mrb_gc_free_hash(mrb_state*, struct RHash*);
 
-/** @} */
 MRB_END_DECL
 
 #endif  /* MRUBY_HASH_H */
diff --git a/include/mruby/irep.h b/include/mruby/irep.h
@@ -11,10 +11,7 @@
 #include "mruby/compile.h"
 
 /**
- * @file mruby/irep.h
- * @defgroup mruby_irep Compiled mruby scripts.
- * @ingroup mruby
- * @{
+ * Compiled mruby scripts.
  */
 MRB_BEGIN_DECL
 
@@ -58,7 +55,6 @@ void mrb_irep_free(mrb_state*, struct mrb_irep*);
 void mrb_irep_incref(mrb_state*, struct mrb_irep*);
 void mrb_irep_decref(mrb_state*, struct mrb_irep*);
 
-/** @} */
 MRB_END_DECL
 
 #endif  /* MRUBY_IREP_H */
diff --git a/include/mruby/khash.h b/include/mruby/khash.h
@@ -13,10 +13,7 @@
 #include "mruby/common.h"
 
 /**
- * @file mruby/khash.h
- * @defgroup mruby_khash khash definitions used in mruby's hash table.
- * @ingroup mruby
- * @{
+ * khash definitions used in mruby's hash table.
  */
 MRB_BEGIN_DECL
 
@@ -272,7 +269,6 @@ static inline khint_t __ac_X31_hash_string(const char *s)
 
 typedef const char *kh_cstr_t;
 
-/** @} */
 MRB_END_DECL
 
 #endif  /* MRUBY_KHASH_H */
diff --git a/include/mruby/numeric.h b/include/mruby/numeric.h
@@ -10,13 +10,9 @@
 #include "mruby/common.h"
 
 /**
- * @file mruby/numeric.h
- * @defgroup mruby_numeric Numeric class and it's sub-classes.
+ * Numeric class and it's sub-classes.
  *
- * Numeric, Integer, Float, Fixnum classes
- *
- * @ingroup mruby
- * @{
+ * Integer, Float and Fixnum
  */
 MRB_BEGIN_DECL
 
@@ -113,7 +109,6 @@ mrb_int_sub_overflow(mrb_int minuend, mrb_int subtrahend, mrb_int *difference)
 #undef MRB_UINT_MAKE
 #undef MRB_UINT_MAKE2
 
-/** @} */
 MRB_END_DECL
 
 #endif  /* MRUBY_NUMERIC_H */
diff --git a/include/mruby/proc.h b/include/mruby/proc.h
@@ -11,10 +11,7 @@
 #include "mruby/irep.h"
 
 /**
- * @file mruby/proc.h
- * @defgroup mruby_proc Proc class
- * @ingroup mruby
- * @{
+ * Proc class
  */
 MRB_BEGIN_DECL
 
@@ -74,7 +71,6 @@ MRB_API mrb_value mrb_proc_cfunc_env_get(mrb_state*, mrb_int);
 #include "mruby/khash.h"
 KHASH_DECLARE(mt, mrb_sym, struct RProc*, TRUE)
 
-/** @} */
 MRB_END_DECL
 
 #endif  /* MRUBY_PROC_H */
diff --git a/include/mruby/range.h b/include/mruby/range.h
@@ -10,10 +10,7 @@
 #include "mruby/common.h"
 
 /**
- * @file mruby/range.h
- * @defgroup mruby_range Range class
- * @ingroup mruby
- * @{
+ * Range class
  */
 MRB_BEGIN_DECL
 
@@ -35,7 +32,6 @@ MRB_API mrb_value mrb_range_new(mrb_state*, mrb_value, mrb_value, mrb_bool);
 MRB_API mrb_bool mrb_range_beg_len(mrb_state *mrb, mrb_value range, mrb_int *begp, mrb_int *lenp, mrb_int len);
 mrb_value mrb_get_values_at(mrb_state *mrb, mrb_value obj, mrb_int olen, mrb_int argc, const mrb_value *argv, mrb_value (*func)(mrb_state*, mrb_value, mrb_int));
 
-/** @} */
 MRB_END_DECL
 
 #endif  /* MRUBY_RANGE_H */