Updated doxygen documentation to all headers in PJMEDIA

git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@518 74dad513-b988-da41-8d7b-12977e46ad98

1 files changed, 11 insertions, 10 deletions

diff --git a/pjmedia/docs/doxygen.cfg b/pjmedia/docs/doxygen.cfg
index 9e8e36d1..1a466a43 100644
--- a/pjmedia/docs/doxygen.cfg
+++ b/pjmedia/docs/doxygen.cfg
@@ -17,7 +17,7 @@
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 

 # by quotes) that should identify the project.

 

-PROJECT_NAME           =  PJMEDIA

+PROJECT_NAME           =  "PJMEDIA and PJMEDIA-CODEC"

 

 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 

 # This could be handy for archiving the generated documentation or 

@@ -107,7 +107,7 @@ BRIEF_MEMBER_DESC      = YES
 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 

 # brief descriptions will be completely suppressed.

 

-REPEAT_BRIEF           = YES

+REPEAT_BRIEF           = NO

 

 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 

 # Doxygen will generate a detailed section even if there is only a brief 

@@ -133,7 +133,7 @@ FULL_PATH_NAMES        = NO
 # only done if one of the specified strings matches the left-hand part of 

 # the path. It is allowed to use relative paths in the argument list.

 

-STRIP_FROM_PATH        = "c:\project\pjproject"

+STRIP_FROM_PATH        = "/c/project/pjproject/pjmedia"

 

 # The INTERNAL_DOCS tag determines if documentation 

 # that is typed after a \internal command is included. If the tag is set 

@@ -154,7 +154,7 @@ CASE_SENSE_NAMES       = YES
 # (but less readable) file names. This can be useful is your file systems 

 # doesn't support long names like on DOS, Mac, or CD-ROM.

 

-SHORT_NAMES            = YES

+SHORT_NAMES            = NO

 

 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 

 # will show members with their full class and namespace scopes in the 

@@ -166,7 +166,7 @@ HIDE_SCOPE_NAMES       = NO
 # will generate a verbatim copy of the header file for each class for 

 # which an include is specified. Set to NO to disable this.

 

-VERBATIM_HEADERS       = YES

+VERBATIM_HEADERS       = NO

 

 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 

 # will put list of the files that are included by a file in the documentation 

@@ -345,7 +345,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories 

 # with spaces.

 

-INPUT                  =  include/pjmedia

+INPUT                  =  include

 

 # If the value of the INPUT tag contains directories, you can use the 

 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 

@@ -403,7 +403,7 @@ EXAMPLE_RECURSIVE      = NO
 # directories that contain image that are included in the documentation (see 

 # the \image command).

 

-IMAGE_PATH             = 

+IMAGE_PATH             = docs

 

 # The INPUT_FILTER tag can be used to specify a program that doxygen should 

 # invoke to filter for each input file. Doxygen will invoke the filter program 

@@ -494,7 +494,7 @@ HTML_OUTPUT            = html
 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 

 # doxygen will generate files with .html extension.

 

-HTML_FILE_EXTENSION    = .html

+HTML_FILE_EXTENSION    = .htm

 

 # The HTML_HEADER tag can be used to specify a personal HTML header for 

 # each generated HTML page. If it is left blank doxygen will generate a 

@@ -568,7 +568,7 @@ DISABLE_INDEX          = NO
 # This tag can be used to set the number of enum values (range [1..20]) 

 # that doxygen will group on one line in the generated HTML documentation.

 

-ENUM_VALUES_PER_LINE   = 4

+ENUM_VALUES_PER_LINE   = 1

 

 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be

 # generated containing a tree-like index structure (just like the one that 

@@ -842,7 +842,8 @@ INCLUDE_FILE_PATTERNS  =
 # omitted =1 is assumed.

 

 PREDEFINED             = PJ_DECL(x)=x PJ_DEF(x)=x PJ_IDECL(x)=x \

-			 PJ_IDEF(x)=x PJ_INLINE(x)=x

+			 PJ_IDEF(x)=x PJ_INLINE(x)=x \

+			 PJ_BEGIN_DECL= PJ_END_DECL=

 

 # 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.