summaryrefslogtreecommitdiffhomepage
path: root/include
diff options
context:
space:
mode:
authorSeba Gamboa <[email protected]>2015-09-28 19:15:59 -0300
committerSeba Gamboa <[email protected]>2015-10-08 12:29:10 -0300
commita0fe0c40b103411dd9e98f153fab8cbb35c7fa93 (patch)
tree29987f31e4984fbaa8767ec37e49f3aa93b9e809 /include
parent554406b987bde19f25aef2adbc1431d8f30f9871 (diff)
downloadmruby-a0fe0c40b103411dd9e98f153fab8cbb35c7fa93.tar.gz
mruby-a0fe0c40b103411dd9e98f153fab8cbb35c7fa93.zip
Remove old doxygen tags
Diffstat (limited to 'include')
-rw-r--r--include/mruby.h28
-rw-r--r--include/mruby/array.h11
-rw-r--r--include/mruby/class.h6
-rw-r--r--include/mruby/common.h13
-rw-r--r--include/mruby/compile.h5
-rw-r--r--include/mruby/data.h7
-rw-r--r--include/mruby/debug.h6
-rw-r--r--include/mruby/dump.h6
-rw-r--r--include/mruby/error.h6
-rw-r--r--include/mruby/gc.h6
-rw-r--r--include/mruby/hash.h6
-rw-r--r--include/mruby/irep.h6
-rw-r--r--include/mruby/khash.h6
-rw-r--r--include/mruby/numeric.h9
-rw-r--r--include/mruby/proc.h6
-rw-r--r--include/mruby/range.h6
-rw-r--r--include/mruby/string.h6
-rw-r--r--include/mruby/value.h9
-rw-r--r--include/mruby/variable.h6
-rw-r--r--include/mruby/version.h6
20 files changed, 41 insertions, 119 deletions
diff --git a/include/mruby.h b/include/mruby.h
index 3d91b2f51..47d65ee4c 100644
--- 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
index e716c883d..cd4156836 100644
--- 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
index 35edce86c..09565ec08 100644
--- 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
index 01e558291..e7841f38f 100644
--- 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
index c482ddf69..637b469a8 100644
--- 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
index c68b050f7..472829c57 100644
--- 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
index 94ef1e723..553968a86 100644
--- 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
index 293122f9a..6a36cbce6 100644
--- 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
index 347ca7738..8b6430137 100644
--- 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
index a9187bb56..0b33617de 100644
--- a/include/mruby/gc.h
+++ b/include/mruby/gc.h
@@ -10,10 +10,7 @@
#include "mruby/common.h"
/**
- * @file mruby/gc.h
- * @defgroup mruby_gc Uncommon memory management stuffs.
- * @ingroup mruby
- * @{
+ * Uncommon memory management stuffs.
*/
MRB_BEGIN_DECL
@@ -21,7 +18,6 @@ typedef void (mrb_each_object_callback)(mrb_state *mrb, struct RBasic *obj, void
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
index 1f69b4215..ea4a79dc4 100644
--- 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
index 1f08f44fa..aaf8bd0ef 100644
--- 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
index 36119bfcf..4331ef137 100644
--- 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
index a7aa6c81b..6366e8674 100644
--- 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
index 6b8d3cd9f..85096fe5e 100644
--- 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
index e30c71ab5..f97853fc5 100644
--- 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 */
diff --git a/include/mruby/string.h b/include/mruby/string.h
index e182bb6fa..04040663d 100644
--- a/include/mruby/string.h
+++ b/include/mruby/string.h
@@ -10,10 +10,7 @@
#include "mruby/common.h"
/**
- * @file mruby/string.h
- * @defgroup mrb_string String class
- * @ingroup mruby
- * @{
+ * String class
*/
MRB_BEGIN_DECL
@@ -126,7 +123,6 @@ void mrb_regexp_check(mrb_state *mrb, mrb_value obj);
#define mrb_str_buf_cat(mrb, str, ptr, len) mrb_str_cat(mrb, str, ptr, len)
#define mrb_str_buf_append(mrb, str, str2) mrb_str_cat_str(mrb, str, str2)
-/** @} */
MRB_END_DECL
#endif /* MRUBY_STRING_H */
diff --git a/include/mruby/value.h b/include/mruby/value.h
index d9614f356..216fe9279 100644
--- a/include/mruby/value.h
+++ b/include/mruby/value.h
@@ -10,13 +10,7 @@
#include "mruby/common.h"
/**
- * @file mruby/value.h
- * @defgroup mruby_value Value definitions
- *
- * @ref mrb_value functions and macros.
- *
- * @ingroup mruby
- * @{
+ * MRuby Value definition functions and macros.
*/
MRB_BEGIN_DECL
@@ -245,7 +239,6 @@ mrb_ro_data_p(const char *p)
# define mrb_ro_data_p(p) FALSE
#endif
-/** @} */
MRB_END_DECL
#endif /* MRUBY_VALUE_H */
diff --git a/include/mruby/variable.h b/include/mruby/variable.h
index 91d50c106..063d65b71 100644
--- a/include/mruby/variable.h
+++ b/include/mruby/variable.h
@@ -10,10 +10,7 @@
#include "mruby/common.h"
/**
- * @file mruby/variable.h
- * @defgroup mruby_variable Functions to access to mruby variables.
- * @ingroup mruby
- * @{
+ * Functions to access mruby variables.
*/
MRB_BEGIN_DECL
@@ -80,7 +77,6 @@ void mrb_gc_mark_iv(mrb_state*, struct RObject*);
size_t mrb_gc_mark_iv_size(mrb_state*, struct RObject*);
void mrb_gc_free_iv(mrb_state*, struct RObject*);
-/** @} */
MRB_END_DECL
#endif /* MRUBY_VARIABLE_H */
diff --git a/include/mruby/version.h b/include/mruby/version.h
index 09be56811..cf5aa57eb 100644
--- a/include/mruby/version.h
+++ b/include/mruby/version.h
@@ -10,11 +10,7 @@
#include "mruby/common.h"
/**
- * @file mruby/version.h
- * @brief MRuby version macros
- * @defgroup mrb_string MRuby version macros
- * @ingroup MRuby
- * @{
+ * MRuby version macros
*/
MRB_BEGIN_DECL