Commit a0fe0c40 authored by Seba Gamboa's avatar Seba Gamboa

Remove old doxygen tags

parent 554406b9
...@@ -38,9 +38,7 @@ ...@@ -38,9 +38,7 @@
#include "mruby/version.h" #include "mruby/version.h"
/** /**
* @file mruby.h * MRuby C API entry point
* @defgroup mruby MRuby C API
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -56,13 +54,13 @@ struct mrb_irep; ...@@ -56,13 +54,13 @@ struct mrb_irep;
struct mrb_state; 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: * The function pointing it must behave similarly as realloc except:
* - If ptr is NULL it must allocate new space. * - If ptr is NULL it must allocate new space.
* - If s is NULL, ptr must be freed. * - 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); 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); ...@@ -213,16 +211,17 @@ typedef mrb_value (*mrb_func_t)(mrb_state *mrb, mrb_value);
* Defines a new class. * Defines a new class.
* *
* If you're creating a gem it may look something like this: * 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) { * ```c
* //free(TheAnimals); * void mrb_example_gem_init(mrb_state* mrb) {
* } * struct RClass *example_class;
* </pre> * 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 name The name of the defined class
* @param super The new class parent * @param super The new class parent
...@@ -676,7 +675,6 @@ MRB_API void mrb_show_copyright(mrb_state *mrb); ...@@ -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_API mrb_value mrb_format(mrb_state *mrb, const char *format, ...);
/** @} */
MRB_END_DECL MRB_END_DECL
#endif /* MRUBY_H */ #endif /* MRUBY_H */
...@@ -10,10 +10,7 @@ ...@@ -10,10 +10,7 @@
#include "mruby/common.h" #include "mruby/common.h"
/** /**
* @file mruby/array.h * Array class
* @defgroup mruby_array Array class
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -58,7 +55,7 @@ MRB_API mrb_value mrb_ary_new_capa(mrb_state*, mrb_int); ...@@ -58,7 +55,7 @@ MRB_API mrb_value mrb_ary_new_capa(mrb_state*, mrb_int);
* *
* @param mrb * @param mrb
* The MRuby state reference. * The MRuby state reference.
* @returns * @return
* The initialized array * The initialized array
*/ */
MRB_API mrb_value mrb_ary_new(mrb_state *mrb); 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); ...@@ -94,7 +91,7 @@ MRB_API void mrb_ary_push(mrb_state *mrb, mrb_value array, mrb_value value);
* The MRuby state reference. * The MRuby state reference.
* @param ary * @param ary
* The array from which the value will be poped. * The array from which the value will be poped.
* @returns * @return
* The poped value. * The poped value.
*/ */
MRB_API mrb_value mrb_ary_pop(mrb_state *mrb, mrb_value ary); 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); ...@@ -112,7 +109,7 @@ MRB_API mrb_value mrb_ary_pop(mrb_state *mrb, mrb_value ary);
* The target array. * The target array.
* @param n * @param n
* The array index being referenced * The array index being referenced
* @returns * @return
* The referenced value. * The referenced value.
*/ */
MRB_API mrb_value mrb_ary_ref(mrb_state *mrb, mrb_value ary, mrb_int n); MRB_API mrb_value mrb_ary_ref(mrb_state *mrb, mrb_value ary, mrb_int n);
......
...@@ -10,10 +10,7 @@ ...@@ -10,10 +10,7 @@
#include "mruby/common.h" #include "mruby/common.h"
/** /**
* @file mruby/class.h * Class class
* @defgroup mruby_class Class class
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -87,7 +84,6 @@ void mrb_gc_mark_mt(mrb_state*, struct RClass*); ...@@ -87,7 +84,6 @@ void mrb_gc_mark_mt(mrb_state*, struct RClass*);
size_t mrb_gc_mark_mt_size(mrb_state*, struct RClass*); size_t mrb_gc_mark_mt_size(mrb_state*, struct RClass*);
void mrb_gc_free_mt(mrb_state*, struct RClass*); void mrb_gc_free_mt(mrb_state*, struct RClass*);
/** @} */
MRB_END_DECL MRB_END_DECL
#endif /* MRUBY_CLASS_H */ #endif /* MRUBY_CLASS_H */
...@@ -7,12 +7,6 @@ ...@@ -7,12 +7,6 @@
#ifndef MRUBY_COMMON_H #ifndef MRUBY_COMMON_H
#define MRUBY_COMMON_H #define MRUBY_COMMON_H
/**
* @file mruby/common.h
* @defgroup mruby_common Shared compiler macros
* @ingroup mruby
* @{
*/
#ifdef __cplusplus #ifdef __cplusplus
# define MRB_BEGIN_DECL extern "C" { # define MRB_BEGIN_DECL extern "C" {
...@@ -24,6 +18,11 @@ ...@@ -24,6 +18,11 @@
# define MRB_END_DECL # define MRB_END_DECL
#endif #endif
/**
* Shared compiler macros
*/
MRB_BEGIN_DECL
/** Declare a function that never returns. */ /** Declare a function that never returns. */
#if __STDC_VERSION__ >= 201112L #if __STDC_VERSION__ >= 201112L
# define mrb_noreturn _Noreturn # define mrb_noreturn _Noreturn
...@@ -63,6 +62,6 @@ ...@@ -63,6 +62,6 @@
# define MRB_API extern # define MRB_API extern
#endif #endif
/** @} */ MRB_END_DECL
#endif /* MRUBY_COMMON_H */ #endif /* MRUBY_COMMON_H */
...@@ -10,10 +10,7 @@ ...@@ -10,10 +10,7 @@
#include "mruby/common.h" #include "mruby/common.h"
/** /**
* @file mruby/compile.h * MRuby Compiler
* @defgroup mruby_compile Compiler
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
......
...@@ -10,13 +10,9 @@ ...@@ -10,13 +10,9 @@
#include "mruby/common.h" #include "mruby/common.h"
/** /**
* @file mruby/data.h * Custom C wrapped data.
* @defgroup mruby_data Custom C wrapped data.
* *
* Defining Ruby wrappers around native objects. * Defining Ruby wrappers around native objects.
*
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -74,7 +70,6 @@ mrb_data_init(mrb_value v, void *ptr, const mrb_data_type *type) ...@@ -74,7 +70,6 @@ mrb_data_init(mrb_value v, void *ptr, const mrb_data_type *type)
DATA_TYPE(v) = type; DATA_TYPE(v) = type;
} }
/** @} */
MRB_END_DECL MRB_END_DECL
#endif /* MRUBY_DATA_H */ #endif /* MRUBY_DATA_H */
...@@ -10,10 +10,7 @@ ...@@ -10,10 +10,7 @@
#include "mruby/common.h" #include "mruby/common.h"
/** /**
* @file mruby/debug.h * MRuby Debugging.
* @defgroup mruby_debug Debugging.
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -64,7 +61,6 @@ MRB_API mrb_irep_debug_info_file *mrb_debug_info_append_file( ...@@ -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 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_API void mrb_debug_info_free(mrb_state *mrb, mrb_irep_debug_info *d);
/** @} */
MRB_END_DECL MRB_END_DECL
#endif /* MRUBY_DEBUG_H */ #endif /* MRUBY_DEBUG_H */
...@@ -12,10 +12,7 @@ ...@@ -12,10 +12,7 @@
#include "mruby/common.h" #include "mruby/common.h"
/** /**
* @file mruby/dump.h * Dumping compiled mruby script.
* @defgroup mruby_dump Dumping compiled mruby script.
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -190,7 +187,6 @@ bin_to_uint8(const uint8_t *bin) ...@@ -190,7 +187,6 @@ bin_to_uint8(const uint8_t *bin)
return (uint8_t)bin[0]; return (uint8_t)bin[0];
} }
/** @} */
MRB_END_DECL MRB_END_DECL
/** @internal crc.c */ /** @internal crc.c */
......
...@@ -10,10 +10,7 @@ ...@@ -10,10 +10,7 @@
#include "mruby/common.h" #include "mruby/common.h"
/** /**
* @file mruby/error.h * MRuby error handling.
* @defgroup mruby_error Error handling.
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -45,7 +42,6 @@ MRB_API mrb_value mrb_rescue_exceptions(mrb_state *mrb, mrb_func_t body, mrb_val ...@@ -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_func_t rescue, mrb_value r_data,
mrb_int len, struct RClass **classes); mrb_int len, struct RClass **classes);
/** @} */
MRB_END_DECL MRB_END_DECL
#endif /* MRUBY_ERROR_H */ #endif /* MRUBY_ERROR_H */
...@@ -10,10 +10,7 @@ ...@@ -10,10 +10,7 @@
#include "mruby/common.h" #include "mruby/common.h"
/** /**
* @file mruby/gc.h * Uncommon memory management stuffs.
* @defgroup mruby_gc Uncommon memory management stuffs.
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -21,7 +18,6 @@ typedef void (mrb_each_object_callback)(mrb_state *mrb, struct RBasic *obj, void ...@@ -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); 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_API void mrb_free_context(mrb_state *mrb, struct mrb_context *c);
/** @} */
MRB_END_DECL MRB_END_DECL
#endif /* MRUBY_GC_H */ #endif /* MRUBY_GC_H */
...@@ -10,10 +10,7 @@ ...@@ -10,10 +10,7 @@
#include "mruby/common.h" #include "mruby/common.h"
/** /**
* @file mruby/hash.h * Hash class
* @defgroup mruby_hash Hash class
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -53,7 +50,6 @@ void mrb_gc_mark_hash(mrb_state*, struct RHash*); ...@@ -53,7 +50,6 @@ void mrb_gc_mark_hash(mrb_state*, struct RHash*);
size_t mrb_gc_mark_hash_size(mrb_state*, struct RHash*); size_t mrb_gc_mark_hash_size(mrb_state*, struct RHash*);
void mrb_gc_free_hash(mrb_state*, struct RHash*); void mrb_gc_free_hash(mrb_state*, struct RHash*);
/** @} */
MRB_END_DECL MRB_END_DECL
#endif /* MRUBY_HASH_H */ #endif /* MRUBY_HASH_H */
...@@ -11,10 +11,7 @@ ...@@ -11,10 +11,7 @@
#include "mruby/compile.h" #include "mruby/compile.h"
/** /**
* @file mruby/irep.h * Compiled mruby scripts.
* @defgroup mruby_irep Compiled mruby scripts.
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -58,7 +55,6 @@ void mrb_irep_free(mrb_state*, struct mrb_irep*); ...@@ -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_incref(mrb_state*, struct mrb_irep*);
void mrb_irep_decref(mrb_state*, struct mrb_irep*); void mrb_irep_decref(mrb_state*, struct mrb_irep*);
/** @} */
MRB_END_DECL MRB_END_DECL
#endif /* MRUBY_IREP_H */ #endif /* MRUBY_IREP_H */
...@@ -13,10 +13,7 @@ ...@@ -13,10 +13,7 @@
#include "mruby/common.h" #include "mruby/common.h"
/** /**
* @file mruby/khash.h * khash definitions used in mruby's hash table.
* @defgroup mruby_khash khash definitions used in mruby's hash table.
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -272,7 +269,6 @@ static inline khint_t __ac_X31_hash_string(const char *s) ...@@ -272,7 +269,6 @@ static inline khint_t __ac_X31_hash_string(const char *s)
typedef const char *kh_cstr_t; typedef const char *kh_cstr_t;
/** @} */
MRB_END_DECL MRB_END_DECL
#endif /* MRUBY_KHASH_H */ #endif /* MRUBY_KHASH_H */
...@@ -10,13 +10,9 @@ ...@@ -10,13 +10,9 @@
#include "mruby/common.h" #include "mruby/common.h"
/** /**
* @file mruby/numeric.h * Numeric class and it's sub-classes.
* @defgroup mruby_numeric Numeric class and it's sub-classes.
* *
* Numeric, Integer, Float, Fixnum classes * Integer, Float and Fixnum
*
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -113,7 +109,6 @@ mrb_int_sub_overflow(mrb_int minuend, mrb_int subtrahend, mrb_int *difference) ...@@ -113,7 +109,6 @@ mrb_int_sub_overflow(mrb_int minuend, mrb_int subtrahend, mrb_int *difference)
#undef MRB_UINT_MAKE #undef MRB_UINT_MAKE
#undef MRB_UINT_MAKE2 #undef MRB_UINT_MAKE2
/** @} */
MRB_END_DECL MRB_END_DECL
#endif /* MRUBY_NUMERIC_H */ #endif /* MRUBY_NUMERIC_H */
...@@ -11,10 +11,7 @@ ...@@ -11,10 +11,7 @@
#include "mruby/irep.h" #include "mruby/irep.h"
/** /**
* @file mruby/proc.h * Proc class
* @defgroup mruby_proc Proc class
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -74,7 +71,6 @@ MRB_API mrb_value mrb_proc_cfunc_env_get(mrb_state*, mrb_int); ...@@ -74,7 +71,6 @@ MRB_API mrb_value mrb_proc_cfunc_env_get(mrb_state*, mrb_int);
#include "mruby/khash.h" #include "mruby/khash.h"
KHASH_DECLARE(mt, mrb_sym, struct RProc*, TRUE) KHASH_DECLARE(mt, mrb_sym, struct RProc*, TRUE)
/** @} */
MRB_END_DECL MRB_END_DECL
#endif /* MRUBY_PROC_H */ #endif /* MRUBY_PROC_H */
...@@ -10,10 +10,7 @@ ...@@ -10,10 +10,7 @@
#include "mruby/common.h" #include "mruby/common.h"
/** /**
* @file mruby/range.h * Range class
* @defgroup mruby_range Range class
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -35,7 +32,6 @@ MRB_API mrb_value mrb_range_new(mrb_state*, mrb_value, mrb_value, mrb_bool); ...@@ -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_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_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 MRB_END_DECL
#endif /* MRUBY_RANGE_H */ #endif /* MRUBY_RANGE_H */
...@@ -10,10 +10,7 @@ ...@@ -10,10 +10,7 @@
#include "mruby/common.h" #include "mruby/common.h"
/** /**
* @file mruby/string.h * String class
* @defgroup mrb_string String class
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -126,7 +123,6 @@ void mrb_regexp_check(mrb_state *mrb, mrb_value obj); ...@@ -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_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) #define mrb_str_buf_append(mrb, str, str2) mrb_str_cat_str(mrb, str, str2)
/** @} */
MRB_END_DECL MRB_END_DECL
#endif /* MRUBY_STRING_H */ #endif /* MRUBY_STRING_H */
...@@ -10,13 +10,7 @@ ...@@ -10,13 +10,7 @@
#include "mruby/common.h" #include "mruby/common.h"
/** /**
* @file mruby/value.h * MRuby Value definition functions and macros.
* @defgroup mruby_value Value definitions
*
* @ref mrb_value functions and macros.
*
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -245,7 +239,6 @@ mrb_ro_data_p(const char *p) ...@@ -245,7 +239,6 @@ mrb_ro_data_p(const char *p)
# define mrb_ro_data_p(p) FALSE # define mrb_ro_data_p(p) FALSE
#endif #endif
/** @} */
MRB_END_DECL MRB_END_DECL
#endif /* MRUBY_VALUE_H */ #endif /* MRUBY_VALUE_H */
...@@ -10,10 +10,7 @@ ...@@ -10,10 +10,7 @@
#include "mruby/common.h" #include "mruby/common.h"
/** /**
* @file mruby/variable.h * Functions to access mruby variables.
* @defgroup mruby_variable Functions to access to mruby variables.
* @ingroup mruby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
...@@ -80,7 +77,6 @@ void mrb_gc_mark_iv(mrb_state*, struct RObject*); ...@@ -80,7 +77,6 @@ void mrb_gc_mark_iv(mrb_state*, struct RObject*);
size_t mrb_gc_mark_iv_size(mrb_state*, struct RObject*); size_t mrb_gc_mark_iv_size(mrb_state*, struct RObject*);
void mrb_gc_free_iv(mrb_state*, struct RObject*); void mrb_gc_free_iv(mrb_state*, struct RObject*);
/** @} */
MRB_END_DECL MRB_END_DECL
#endif /* MRUBY_VARIABLE_H */ #endif /* MRUBY_VARIABLE_H */
...@@ -10,11 +10,7 @@ ...@@ -10,11 +10,7 @@
#include "mruby/common.h" #include "mruby/common.h"
/** /**
* @file mruby/version.h * MRuby version macros
* @brief MRuby version macros
* @defgroup mrb_string MRuby version macros
* @ingroup MRuby
* @{
*/ */
MRB_BEGIN_DECL MRB_BEGIN_DECL
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment