summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Pool <mbp@samba.org>2001-11-16 07:28:23 +0000
committerMartin Pool <mbp@samba.org>2001-11-16 07:28:23 +0000
commitf6f04b5a44ad37e3ca82c932bb1df64c7254dda5 (patch)
tree431a269253407d848aa1f774c10623ec8243f025
parentfc9b7a8bc61271796455cdc12149311bc76ed588 (diff)
downloadsamba-f6f04b5a44ad37e3ca82c932bb1df64c7254dda5.tar.gz
samba-f6f04b5a44ad37e3ca82c932bb1df64c7254dda5.tar.bz2
samba-f6f04b5a44ad37e3ca82c932bb1df64c7254dda5.zip
Make CodingSuggestions show up in the Doxygen pages.
(This used to be commit b3e34ad3207f53310b2d59c07a4cec765a0f81bf)
-rw-r--r--source3/CodingSuggestions22
-rw-r--r--source3/Doxyfile9
-rw-r--r--source3/mainpage.dox7
3 files changed, 30 insertions, 8 deletions
diff --git a/source3/CodingSuggestions b/source3/CodingSuggestions
index aa19c16d85..60a358919a 100644
--- a/source3/CodingSuggestions
+++ b/source3/CodingSuggestions
@@ -1,3 +1,7 @@
+/**
+
+@page CodingSuggestions Coding suggestions
+
So you want to add code to Samba ...
One of the daunting tasks facing a programmer attempting to write code for
@@ -101,14 +105,22 @@ Here are some other suggestions:
20) Try to use asprintf rather than pstrings and fstrings where possible
-21) Use normal C comments /* like this */ instead of C++ comments // like
- this. Although the C++ comment format is part of the C99 standard,
- some older vendor C compilers do not accept it.
+21) Use normal C comments / * instead of C++ comments // like
+ this. Although the C++ comment format is part of the C99
+ standard, some older vendor C compilers do not accept it.
+
+22) Try to write documentation for API functions and structures
+ explaining the point of the code, the way it should be used, and
+ any special conditions or results. Mark these with a double-star
+ comment start / ** so that they can be picked up by Doxygen, as in
+ this file.
The suggestions above are simply that, suggestions, but the information may
help in reducing the routine rework done on new code. The preceeding list
is expected to change routinely as new support routines and macros are
added.
-Written by Steve French, with contributions from Simo Sorce and Andrew
-Bartlett.
+Written by Steve French, with contributions from Simo Sorce, Andrew
+Bartlett, Tim Potter and Martin Pool.
+
+**/
diff --git a/source3/Doxyfile b/source3/Doxyfile
index c25a45ddc3..327f94fa24 100644
--- a/source3/Doxyfile
+++ b/source3/Doxyfile
@@ -41,6 +41,8 @@ ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
OPTIMIZE_OUTPUT_FOR_C = YES
SHOW_USED_FILES = YES
+REFERENCED_RELATION = YES
+REFERENCED_BY_RELATION = YES
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
@@ -52,7 +54,8 @@ WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
-INPUT = .
+INPUT = . \
+ CodingSuggestions mainpage.dox
FILE_PATTERNS = *.c \
*.h \
*.idl
@@ -79,7 +82,7 @@ HTML_OUTPUT = html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
-HTML_ALIGN_MEMBERS = NO
+HTML_ALIGN_MEMBERS = YE
GENERATE_HTMLHELP = NO
GENERATE_CHI = NO
BINARY_TOC = NO
@@ -123,7 +126,7 @@ GENERATE_XML = NO
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
-ENABLE_PREPROCESSING = YES
+ENABLE_PREPROCESSING = NO
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
diff --git a/source3/mainpage.dox b/source3/mainpage.dox
new file mode 100644
index 0000000000..8b72f80462
--- /dev/null
+++ b/source3/mainpage.dox
@@ -0,0 +1,7 @@
+/**
+
+@mainpage
+
+@li \ref CodingSuggestions
+
+**/