diff options
| -rw-r--r-- | Doxyfile | 22 | ||||
| -rw-r--r-- | docs/install.dox | 2 | ||||
| -rw-r--r-- | docs/mainpage.dox | 10 |
3 files changed, 17 insertions, 17 deletions
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "enet" +PROJECT_NAME = "ENet" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -44,7 +44,7 @@ PROJECT_NUMBER = v1.3.12 # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = "reliable UDP networking library" +PROJECT_BRIEF = "Reliable UDP networking library" # With the PROJECT_LOGO tag one can specify an logo or icon that is included in # the documentation. The maximum height of the logo should not exceed 55 pixels @@ -371,7 +371,7 @@ INLINE_SIMPLE_STRUCTS = NO # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. -TYPEDEF_HIDES_STRUCT = NO +TYPEDEF_HIDES_STRUCT = YES # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be @@ -778,7 +778,7 @@ RECURSIVE = YES # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = Tests +EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded @@ -911,13 +911,13 @@ STRIP_CODE_COMMENTS = YES # function all documented functions referencing it will be listed. # The default value is: NO. -REFERENCED_BY_RELATION = YES +REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. -REFERENCES_RELATION = YES +REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES, then the hyperlinks from functions in REFERENCES_RELATION and @@ -1335,7 +1335,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -DISABLE_INDEX = YES +DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag @@ -1352,7 +1352,7 @@ DISABLE_INDEX = YES # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_TREEVIEW = YES +GENERATE_TREEVIEW = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. @@ -1935,13 +1935,13 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = +PREDEFINED = ENET_CALLBACK= ENET_API= # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The # macro definition that is found in the sources will be used. Use the PREDEFINED -# tag if you want to use a different macro definition that overrules the -# definition found in the source code. +# tag if you want to use a different macro defi ENET_CALLBACK=nition that overrules the +# definition found in the source ENET_CALLBACK=code. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. EXPAND_AS_DEFINED = diff --git a/docs/install.dox b/docs/install.dox index 310fe34..ed22c28 100644 --- a/docs/install.dox +++ b/docs/install.dox @@ -3,7 +3,7 @@ ENet should be trivially simple to integrate with most applications. First, make sure you download the latest source distribution here @ref -SourceDistro. +Downloads. @section Unix Unix-like Operating Systems diff --git a/docs/mainpage.dox b/docs/mainpage.dox index 496ad2e..fabc6d0 100644 --- a/docs/mainpage.dox +++ b/docs/mainpage.dox @@ -1,4 +1,4 @@ -/** @mainpage enet +/** @mainpage ENet <center>http://enet.bespin.org</center> <hr> @@ -14,7 +14,7 @@ portable, and easily embeddable. @ref Features -@ref SourceDistro +@ref Downloads @ref Installation @@ -31,7 +31,7 @@ portable, and easily embeddable. */ /** -@page SourceDistro Source Distribution +@page Downloads Downloads You can retrieve the source to ENet by downloading it in either .tar.gz form or accessing the github distribution directly. @@ -44,14 +44,14 @@ You can find the most recent ENet source at <a href="https://github.com/lsalzman */ /** -@page MailingList ENet Mailing List +@page MailingList Mailing List The <a href="http://lists.cubik.org/mailman/listinfo/enet-discuss">enet-discuss</a> list is for discussion of ENet, including bug reports or feature requests. */ /** -@page IRCChannel ENet IRC Channel +@page IRCChannel IRC Channel Join the \#enet channel on the freenode IRC network (irc.freenode.net) for real-time discussion about the ENet library. |