From: discomfitor Date: Mon, 20 Sep 2010 20:33:50 +0000 (+0000) Subject: doxy error fixes X-Git-Tag: accepted/2.0/20130306.224007~195^2~676 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=272598be249baf8b7c90b364ba7844d16845d743;p=profile%2Fivi%2Fecore.git doxy error fixes git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/ecore@52512 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33 --- diff --git a/doc/Doxyfile b/doc/Doxyfile index f898c07..93705ee 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -1,138 +1,221 @@ +DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = Ecore PROJECT_NUMBER = OUTPUT_DIRECTORY = . -INPUT = ./ecore.dox ../src/lib -IMAGE_PATH = img +CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English -GENERATE_HTML = YES -HTML_OUTPUT = html -HTML_FILE_EXTENSION = .html -HTML_HEADER = head.html -HTML_FOOTER = foot.html -HTML_STYLESHEET = e.css -HTML_ALIGN_MEMBERS = YES -ENUM_VALUES_PER_LINE = 1 -GENERATE_HTMLHELP = NO -CHM_FILE = -HHC_LOCATION = -GENERATE_CHI = NO -BINARY_TOC = NO -TOC_EXPAND = NO -DISABLE_INDEX = YES +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = +STRIP_FROM_INC_PATH = +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = YES +QT_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 2 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = YES +OPTIMIZE_OUTPUT_JAVA = NO +OPTIMIZE_FOR_FORTRAN = NO +OPTIMIZE_OUTPUT_VHDL = NO +EXTENSION_MAPPING = +BUILTIN_STL_SUPPORT = NO +CPP_CLI_SUPPORT = NO +SIP_SUPPORT = NO +IDL_PROPERTY_SUPPORT = YES +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES +TYPEDEF_HIDES_STRUCT = NO +SYMBOL_CACHE_SIZE = 0 EXTRACT_ALL = NO EXTRACT_PRIVATE = NO EXTRACT_STATIC = NO EXTRACT_LOCAL_CLASSES = NO +EXTRACT_LOCAL_METHODS = NO +EXTRACT_ANON_NSPACES = NO HIDE_UNDOC_MEMBERS = YES HIDE_UNDOC_CLASSES = YES HIDE_FRIEND_COMPOUNDS = YES -BRIEF_MEMBER_DESC = YES -REPEAT_BRIEF = YES -ALWAYS_DETAILED_SEC = NO -INLINE_INHERITED_MEMB = NO -FULL_PATH_NAMES = NO -STRIP_FROM_PATH = +HIDE_IN_BODY_DOCS = NO INTERNAL_DOCS = NO -STRIP_CODE_COMMENTS = YES CASE_SENSE_NAMES = YES -SHORT_NAMES = NO HIDE_SCOPE_NAMES = NO -VERBATIM_HEADERS = NO SHOW_INCLUDE_FILES = NO -JAVADOC_AUTOBRIEF = YES -MULTILINE_CPP_IS_BRIEF = NO -DETAILS_AT_TOP = NO -INHERIT_DOCS = YES +FORCE_LOCAL_INCLUDES = NO INLINE_INFO = YES SORT_MEMBER_DOCS = YES -DISTRIBUTE_GROUP_DOC = NO -TAB_SIZE = 2 +SORT_BRIEF_DOCS = NO +SORT_MEMBERS_CTORS_1ST = NO +SORT_GROUP_NAMES = NO +SORT_BY_SCOPE_NAME = NO GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES GENERATE_DEPRECATEDLIST= YES -ALIASES = -ENABLED_SECTIONS = +ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 -OPTIMIZE_OUTPUT_FOR_C = YES -OPTIMIZE_OUTPUT_JAVA = NO SHOW_USED_FILES = NO +SHOW_DIRECTORIES = NO +SHOW_FILES = YES +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +LAYOUT_FILE = QUIET = YES WARNINGS = YES WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO WARN_FORMAT = "$file:$line: $text" -WARN_LOGFILE = +WARN_LOGFILE = +INPUT = ./ecore.dox \ + ../src/lib +INPUT_ENCODING = UTF-8 FILE_PATTERNS = -RECURSIVE = YES +RECURSIVE = YES +EXCLUDE = EXCLUDE_SYMLINKS = NO -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = +EXCLUDE_SYMBOLS = EXAMPLE_PATH = ../examples/ -EXAMPLE_PATTERNS = +EXAMPLE_PATTERNS = EXAMPLE_RECURSIVE = NO -INPUT_FILTER = +IMAGE_PATH = img +INPUT_FILTER = +FILTER_PATTERNS = FILTER_SOURCE_FILES = NO SOURCE_BROWSER = NO INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES REFERENCED_BY_RELATION = YES REFERENCES_RELATION = YES +REFERENCES_LINK_SOURCE = YES +USE_HTAGS = NO +VERBATIM_HEADERS = NO ALPHABETICAL_INDEX = YES COLS_IN_ALPHA_INDEX = 2 -IGNORE_PREFIX = +IGNORE_PREFIX = +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = head.html +HTML_FOOTER = foot.html +HTML_STYLESHEET = e.css +HTML_COLORSTYLE_HUE = 220 +HTML_COLORSTYLE_SAT = 100 +HTML_COLORSTYLE_GAMMA = 80 +HTML_TIMESTAMP = YES +HTML_ALIGN_MEMBERS = YES +HTML_DYNAMIC_SECTIONS = NO +GENERATE_DOCSET = NO +DOCSET_FEEDNAME = "Doxygen generated docs" +DOCSET_BUNDLE_ID = org.doxygen.Project +DOCSET_PUBLISHER_ID = org.doxygen.Publisher +DOCSET_PUBLISHER_NAME = Publisher +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +CHM_INDEX_ENCODING = +BINARY_TOC = NO +TOC_EXPAND = NO +GENERATE_QHP = NO +QCH_FILE = +QHP_NAMESPACE = org.doxygen.Project +QHP_VIRTUAL_FOLDER = doc +QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = +QHG_LOCATION = +GENERATE_ECLIPSEHELP = NO +ECLIPSE_DOC_ID = org.doxygen.Project +DISABLE_INDEX = YES +ENUM_VALUES_PER_LINE = 1 GENERATE_TREEVIEW = NO +USE_INLINE_TREES = NO TREEVIEW_WIDTH = 250 +EXT_LINKS_IN_WINDOW = NO +FORMULA_FONTSIZE = 10 +FORMULA_TRANSPARENT = YES +SEARCHENGINE = NO +SERVER_BASED_SEARCH = NO GENERATE_LATEX = YES LATEX_OUTPUT = latex LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex COMPACT_LATEX = NO PAPER_TYPE = a4wide -EXTRA_PACKAGES = -LATEX_HEADER = +EXTRA_PACKAGES = +LATEX_HEADER = PDF_HYPERLINKS = YES USE_PDFLATEX = NO LATEX_BATCHMODE = NO +LATEX_HIDE_INDICES = NO +LATEX_SOURCE_CODE = NO GENERATE_RTF = NO RTF_OUTPUT = rtf COMPACT_RTF = NO RTF_HYPERLINKS = NO -RTF_STYLESHEET_FILE = -RTF_EXTENSIONS_FILE = +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = GENERATE_MAN = YES MAN_OUTPUT = man MAN_EXTENSION = .3 MAN_LINKS = YES GENERATE_XML = NO -XML_SCHEMA = -XML_DTD = +XML_OUTPUT = xml +XML_SCHEMA = +XML_DTD = +XML_PROGRAMLISTING = YES GENERATE_AUTOGEN_DEF = NO +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = ENABLE_PREPROCESSING = YES MACRO_EXPANSION = NO EXPAND_ONLY_PREDEF = NO SEARCH_INCLUDES = NO INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = -PREDEFINED = -EXPAND_AS_DEFINED = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES -TAGFILES = -GENERATE_TAGFILE = +TAGFILES = +GENERATE_TAGFILE = ALLEXTERNALS = NO EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl CLASS_DIAGRAMS = NO +MSCGEN_PATH = HIDE_UNDOC_RELATIONS = YES HAVE_DOT = NO +DOT_NUM_THREADS = 0 +DOT_FONTNAME = FreeSans.ttf +DOT_FONTSIZE = 10 +DOT_FONTPATH = CLASS_GRAPH = NO COLLABORATION_GRAPH = NO +GROUP_GRAPHS = YES +UML_LOOK = NO TEMPLATE_RELATIONS = NO INCLUDE_GRAPH = NO INCLUDED_BY_GRAPH = NO +CALL_GRAPH = NO +CALLER_GRAPH = NO GRAPHICAL_HIERARCHY = NO +DIRECTORY_GRAPH = YES DOT_IMAGE_FORMAT = png -DOT_PATH = -DOTFILE_DIRS = -MAX_DOT_GRAPH_WIDTH = 512 -MAX_DOT_GRAPH_HEIGHT = 512 +DOT_PATH = +DOTFILE_DIRS = +DOT_GRAPH_MAX_NODES = 50 +MAX_DOT_GRAPH_DEPTH = 0 +DOT_TRANSPARENT = NO +DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES DOT_CLEANUP = YES -SEARCHENGINE = NO diff --git a/doc/ecore.dox.in b/doc/ecore.dox.in index 94cbe12..5c763d8 100644 --- a/doc/ecore.dox.in +++ b/doc/ecore.dox.in @@ -42,8 +42,8 @@ These routines are used for Ecore Library interaction @author Andre Dieb @author Mathieu Taillefumier @author Rui Miguel Silva Seabra -@author Saumsung Electronics -@author Samsung SAIT +@author Saumsung Electronics +@author Samsung SAIT @author Nicolas Aguirre @author Brett Nash @author Mike Blumenkrantz @@ -218,7 +218,7 @@ follows the same principles as shown in this example. */ -/** +/* @page Ecore_Config_Page The Enlightened Property Library The Enlightened Property Library (Ecore_Config) is an adbstraction @@ -237,53 +237,6 @@ The following examples show how to use the Enlightened Property Library: */ /** -@page Ecore_ADT_Page Ecore Abstract Data Types - -This page briefly describes the different abstract data types -that are provided by the Ecore library for general usage. You need to -include the @link Ecore_Data.h Ecore_Data.h @endlink to use them. - -@section Ecore_ADT_List List - -A list is a simple data type where one each piece of data points to -another piece of data. - -Associated modules that describe the List ADT include: -@li @ref Ecore_Data_List_Creation_Group -@li @ref Ecore_Data_List_Add_Item_Group -@li @ref Ecore_Data_List_Remove_Item_Group -@li @ref Ecore_Data_List_Traverse_Group -@li @ref Ecore_Data_List_Node_Group - -Examples involving lists include: -@li @link list_example.c list_example.c @endlink - -@section Ecore_ADT_DList Doubly Linked List - -A doubly linked list is like a linked list, only each piece of data -can also point to the piece before it. In other words, you can traverse -a doubly linked list in both directions. - -Associated modules that describe the DList ADT include: -@li @ref Ecore_Data_DList_Creation_Group -@li @ref Ecore_Data_DList_Add_Item_Group -@li @ref Ecore_Data_DList_Remove_Item_Group - -@section Ecore_ADT_Hash Hash - -A hash is an abstract data type where one value is associated with another -value. Instead of each element of the group being accessible using a -number, each element is accessed using another object. - -Associated modules that describe the Hash ADT include: -@li @ref Ecore_Data_Hash_ADT_Creation_Group -@li @ref Ecore_Data_Hash_ADT_Destruction_Group -@li @ref Ecore_Data_Hash_ADT_Data_Group - -@todo Finish this. -*/ - -/** @page X_Window_System_Page X Window System The Ecore library includes a wrapper for handling the X window system. @@ -335,7 +288,7 @@ state. */ -/** +/* @defgroup Ecore_Config_Create_Group Ecore Config Create Functions Convenience functions that set default values, bounds, option values and @@ -351,52 +304,42 @@ Functions that are used to load and save properties from and to files. // EXAMPLES /** -@example args_example.c +@example ecore_args_example.c Shows how to set and retrieve the program arguments. */ /** -@example con_server_example.c +@example ecore_con_server_example.c Shows how to write a simple server using the Ecore_Con library. */ /** -@example con_client_example.c +@example ecore_con_client_example.c Shows how to write a simple client, that connects to the example server. */ /** -@example event_handler_example.c +@example ecore_event_handler_example.c Shows how to use event handlers. */ /** -@example timer_example.c +@example ecore_timer_example.c Demonstrates use of the ecore_timer. */ -/** -@example config_basic_example.c +/* +@example ecore_config_basic_example.c Provides an example of how to use the basic configuration functions. See the file Ecore_Config.h for the full list of available functions. */ -/** -@example config_listener_example.c +/* +@example ecore_config_listener_example.c Shows how to set up a listener to listen for configuration changes. */ /** -@example list_example.c -Provides a basic example of how to append to and traverse a list. -*/ - -/** -@example list_destroy_example.c -Shows how to set and use a destructor for an Ecore_List. -*/ - -/** -@example x_window_example.c +@example ecore_x_window_example.c Shows the basics of using the X Windows system through Ecore functions. */ diff --git a/src/lib/ecore/ecore_thread.c b/src/lib/ecore/ecore_thread.c index e89af2c..0339423 100644 --- a/src/lib/ecore/ecore_thread.c +++ b/src/lib/ecore/ecore_thread.c @@ -967,7 +967,6 @@ ecore_thread_local_data_add(Ecore_Thread *thread, const char *key, void *value, * @param key The name string to add the data with * @param value The data to add * @param cb The callback to free the data with - * @param direct If true, this will not copy the key string (like eina_hash_direct_add) * @return The old data associated with @p key on success if modified, NULL if added * This adds/modifies data in the thread context, adding only if modify fails. * This function can only be called by a *_run thread INSIDE the thread. @@ -1120,7 +1119,7 @@ ecore_thread_global_data_add(const char *key, void *value, Eina_Free_Cb cb, Eina * @param key The name string to add the data with * @param value The data to add * @param cb The optional callback to free the data with once ecore is shut down - * @return An @ref Ecore_Thread_Data on success, NULL on failure + * @return An Ecore_Thread_Data on success, NULL on failure * This adds data to the global thread data and returns NULL, or replaces the previous data * associated with @p key and returning the previous data if it existed. To see if an error occurred, * one must use eina_error_get. diff --git a/src/lib/ecore_con/Ecore_Con.h b/src/lib/ecore_con/Ecore_Con.h index 8907459..f822df3 100644 --- a/src/lib/ecore_con/Ecore_Con.h +++ b/src/lib/ecore_con/Ecore_Con.h @@ -67,38 +67,38 @@ /** * @addtogroup Ecore_Con_Events_Group Events * - * @li @ref ECORE_CON_CLIENT_ADD: Whenever a client connection is made to an + * @li ECORE_CON_CLIENT_ADD: Whenever a client connection is made to an * @c Ecore_Con_Server, an event of this type is emitted, allowing the * retrieval of the client's ip with @ref ecore_con_client_ip_get and * associating data with the client using ecore_con_client_data_set. - * @li @ref ECORE_CON_EVENT_CLIENT_DEL: Whenever a client connection to an + * @li ECORE_CON_EVENT_CLIENT_DEL: Whenever a client connection to an * @c Ecore_Con_Server, an event of this type is emitted. The contents of * the data with this event are variable, but if the client object in the data * is non-null, it must be freed with @ref ecore_con_client_del. - * @li @ref ECORE_CON_EVENT_SERVER_ADD: Whenever a server object is created + * @li ECORE_CON_EVENT_SERVER_ADD: Whenever a server object is created * with @ref ecore_con_server_connect, an event of this type is emitted, * allowing for data to be serialized and sent to the server using * @ref ecore_con_server_send. At this point, the http handshake has * occurred. - * @li @ref ECORE_CON_EVENT_SERVER_DEL: Whenever a server object is destroyed, + * @li ECORE_CON_EVENT_SERVER_DEL: Whenever a server object is destroyed, * usually by the server connection being refused or dropped, an event of this * type is emitted. The contents of the data with this event are variable, * but if the server object in the data is non-null, it must be freed * with @ref ecore_con_server_del. - * @li @ref ECORE_CON_EVENT_CLIENT_DATA: Whenever a client connects to your server + * @li ECORE_CON_EVENT_CLIENT_DATA: Whenever a client connects to your server * object and sends data, an event of this type is emitted. The data will contain both * the size and contents of the message sent by the client. It should be noted that * data within this object is transient, so it must be duplicated in order to be * retained. This event will continue to occur until the client has stopped sending its * message, so a good option for storing this data is an Eina_Strbuf. Once the message has - * been received in full, the client object must be freed with @ref ecore_con_client_free. - * @li @ref ECORE_CON_EVENT_SERVER_DATA: Whenever your server object connects to its destination + * been received in full, the client object must be freed with ecore_con_client_free. + * @li ECORE_CON_EVENT_SERVER_DATA: Whenever your server object connects to its destination * and receives data, an event of this type is emitted. The data will contain both * the size and contents of the message sent by the server. It should be noted that * data within this object is transient, so it must be duplicated in order to be * retained. This event will continue to occur until the server has stopped sending its * message, so a good option for storing this data is an Eina_Strbuf. Once the message has - * been received in full, the server object must be freed with @ref ecore_con_server_free. + * been received in full, the server object must be freed with ecore_con_server_free. * */ @@ -135,7 +135,9 @@ typedef void (*Ecore_Con_Dns_Cb)(const char *canonname, * Types for an ecore_con client/server object. A correct way to set this type is * with an ECORE_CON_$TYPE, optionally OR'ed with an ECORE_CON_$USE if encryption is desired, * and LOAD_CERT if the previously loaded certificate should be used. - * @example ECORE_CON_REMOTE_TCP | ECORE_CON_USE_TLS | ECORE_CON_LOAD_CERT + * @code + * ECORE_CON_REMOTE_TCP | ECORE_CON_USE_TLS | ECORE_CON_LOAD_CERT + * @endcode */ typedef enum _Ecore_Con_Type {