kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doxygen docs: Fix illegal references 

Mostly typos and unescaped # signs
This commit is contained in:
Xavi Artigas 2020-03-12 13:52:42 +01:00
parent 500b9f611b
commit a004befea5
4 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/eo_tutorial.dox
View File

@ -120,11 +120,11 @@
* *
* @section create_class_h_side How to create a class - H side? * @section create_class_h_side How to create a class - H side?
* - If the object is new, establish the public APIs * - If the object is new, establish the public APIs
* - #define \$(CLASS_NAME) \$(class_name)_class_get(): will be used to access data/inherit from this class... * - \#define \$(CLASS_NAME) \$(class_name)_class_get(): will be used to access data/inherit from this class...
* - const Eo_Class *\$(class_name)_class_get(void) EINA_CONST: declaration of the function that will create the class (not the instance), i.e virtual table... * - const Eo_Class *\$(class_name)_class_get(void) EINA_CONST: declaration of the function that will create the class (not the instance), i.e virtual table...
* - extern EAPI Eo_Op \$(CLASS_NAME)_BASE_ID: class id that will be essentially used to identify functions set of this class * - extern EAPI Eo_Op \$(CLASS_NAME)_BASE_ID: class id that will be essentially used to identify functions set of this class
* - enum of the function ids of the class in the form \$(CLASS_NAME)_SUB_ID: used to identify the function inside the class; function id is unique per class but (class id, function id) is unique per system.. * - enum of the function ids of the class in the form \$(CLASS_NAME)_SUB_ID: used to identify the function inside the class; function id is unique per class but (class id, function id) is unique per system..
* - #define \$(CLASS_NAME)_ID(sub_id) (\$(CLASS_NAME)_BASE_ID + sub_id): formula to calculate the system function id * - \#define \$(CLASS_NAME)_ID(sub_id) (\$(CLASS_NAME)_BASE_ID + sub_id): formula to calculate the system function id
* - define of each function consists of: * - define of each function consists of:
* - the name of the function that will be used in eo_do * - the name of the function that will be used in eo_do
* - parameters without types * - parameters without types

2
src/bin/edje/edje_cc_handlers.c
View File

@ -4562,7 +4562,7 @@ st_collections_group_name(void)
This property can be inherited. This property can be inherited.
Defaults: 0 Defaults: 0
@warning Your edc file should always wrap this keyword with #ifdef HAVE_SKIP_NAMESPACE_VALIDATION @warning Your edc file should always wrap this keyword with <tt>\#ifdef HAVE_SKIP_NAMESPACE_VALIDATION</tt>
@since 1.21 @since 1.21
@endproperty @endproperty
*/ */

4
src/lib/eina/eina_value.h
View File

@ -3256,7 +3256,7 @@ static inline Eina_Bool eina_value_struct_setup(Eina_Value *value,
* *
* @param[in] value Value object * @param[in] value Value object
* @return structure description, with all members and size. * @return structure description, with all members and size.
* on failure, #NULL is returned. * on failure, @c NULL is returned.
* *
* @since 1.21 * @since 1.21
*/ */
@ -3706,7 +3706,7 @@ EAPI const char *eina_value_type_name_get(const Eina_Value_Type *type) EINA_PURE
* @param[in] type Type reference. * @param[in] type Type reference.
* @return #EINA_TRUE if valid, #EINA_FALSE otherwise. * @return #EINA_TRUE if valid, #EINA_FALSE otherwise.
* *
* A type is invalid if it's NULL or if version field is not the same * A type is invalid if it's @c NULL or if version field is not the same
* as runtime #EINA_VALUE_TYPE_VERSION. * as runtime #EINA_VALUE_TYPE_VERSION.
* *
* @since 1.2 * @since 1.2

2
src/lib/evas/filters/evas_filter_parser.c
View File

@ -1173,7 +1173,7 @@ _blur_instruction_prepare(Evas_Filter_Program *pgm, Evas_Filter_Instruction *ins
@param src Source buffer. This should be an alpha buffer. @param src Source buffer. This should be an alpha buffer.
@param dst Destination buffer. This should be an RGBA buffer (although alpha is supported). Must be of the same size as @a src. @param dst Destination buffer. This should be an RGBA buffer (although alpha is supported). Must be of the same size as @a src.
@param black The shadows' color. Usually this will be black (@c #000). @param black The shadows' color. Usually this will be black (@c #000).
@param white The specular light's color. Usually this will be white (@c #FFF). @param white The specular light's color. Usually this will be white (@c \#FFF).
@param fillmode This specifies how to handle @a map when its dimensions don't match those of @a src and @a dst. Default is to @c repeat. See @ref evasfilter_fillmode "fillmodes". @param fillmode This specifies how to handle @a map when its dimensions don't match those of @a src and @a dst. Default is to @c repeat. See @ref evasfilter_fillmode "fillmodes".
@note As of 2014/02/11, the ALPHA to RGBA support is of much better quality than ALPHA only, but @b very slow. RGBA sources are not supported yet. @note As of 2014/02/11, the ALPHA to RGBA support is of much better quality than ALPHA only, but @b very slow. RGBA sources are not supported yet.