Skip to content

Commit

Permalink
doxygen: update config handling
Browse files Browse the repository at this point in the history 
- comment out obeolete tags (as of doxygen v1.8.15)
- update element list (include new objects, remove obsolete objects)
- align in alphabetic order (decending)

Signed-off-by: Ralf Zerres <ralf.zerres@networkx.de>
(cherry picked from commit 6f577a9)
  • Loading branch information
@rzerres @razvancrainea
rzerres authored and razvancrainea committed May 28, 2019
1 parent 9d61b80 commit daf5978
Showing 1 changed file with 141 additions and 29 deletions.
170 changes: 141 additions & 29 deletions doc/doxygen/opensips-doxygen
View file
Expand Up @@ -154,12 +154,13 @@ QT_AUTOBRIEF = NO

MULTILINE_CPP_IS_BRIEF = NO

### Has become obsolete
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
# will output the detailed description near the top, like JavaDoc.
# If set to NO, the detailed description appears after the member
# documentation.

DETAILS_AT_TOP = NO
# DETAILS_AT_TOP = NO

# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
Expand Down Expand Up @@ -401,11 +402,12 @@ MAX_INITIALIZER_LINES = 5

SHOW_USED_FILES = YES

### has become obsolete
# If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation. The default is NO.

SHOW_DIRECTORIES = YES
#SHOW_DIRECTORIES = YES

# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from the
Expand Down Expand Up @@ -478,86 +480,193 @@ WARN_LOGFILE =
# with spaces.

INPUT = ./ \
aaa \
cachedb \
cachedb/example \
cachedb/test \
db \
db/schema \
db/example \
evi \
lib \
lib/dbg \
lib/json \
lib/reg \
mem \
menuconfig \
mi \
modules/acc \
modules/aaa_radius \
modules/acc \
modules/alias_db \
modules/auth \
modules/auth_aaa \
modules/auth_db \
modules/auth_diameter \
modules/auth_radius \
modules/avpops \
modules/avp_radius \
modules/b2b_entities \
modules/b2b_logic \
modules/b2b_sca \
modules/benchmark \
modules/cachedb_cassandra \
modules/cachedb_couchbase \
modules/cachedb_local \
modules/cachedb_memcached \
modules/cachedb_mongodb \
modules/cachedb_redis \
modules/cachedb_sql \
modules/call_center \
modules/call_control \
modules/carrierroute \
modules/cfgutils \
modules/cgrates \
modules/clusterer \
modules/compression \
modules/cpl_c \
modules/carrierroute \
modules/db_berkeley \
modules/db_cachedb \
modules/db_flatstore \
modules/db_http \
modules/db_mysql \
modules/db_oracle \
modules/db_perlvdb \
modules/db_postgres \
modules/db_sqlite \
modules/db_text \
modules/db_unixodbc \
modules/db_virtual \
modules/dialog \
modules/dispatcher \
modules/diversion \
modules/domain \
modules/domainpolicy \
modules/drouting \
modules/emergency \
modules/enum \
modules/event_datagram \
modules/event_flatstore \
modules/event_jsonrpc \
modules/event_rabbitmq \
modules/event_route \
modules/event_routing \
modules/event_virtual \
modules/event_xmlrpc \
modules/exec \
modules/db_flatstore \
modules/fraud_detection \
modules/freeswitch \
modules/freeswitch_scripting \
modules/gflags \
modules/group \
modules/group_radius \
modules/h350 \
modules/httpd \
modules/identity \
modules/imc \
modules/jabber \
modules/json \
modules/jsonrpc \
modules/ldap \
modules/load_balancer \
modules/lua \
modules/mangler \
modules/mathops \
modules/maxfwd \
modules/mediaproxy \
modules/mi_datagram \
modules/mid_registrar \
modules/mi_fifo \
modules/mi_xmlrpc \
modules/mi_html \
modules/mi_http \
modules/mi_xmlrpc_ng \
modules/mi_datagram \
modules/mmgeoip \
modules/msilo \
modules/db_mysql \
modules/nathelper \
modules/options \
modules/osp \
modules/path \
modules/peering \
modules/perl \
modules/perlvdb \
modules/permissions \
modules/pi_http \
modules/pike \
modules/permissions \
modules/pike \
modules/db_postgres \
modules/presence \
modules/permissions \
modules/pike \
modules/presence \
modules/presence_callinfo \
modules/presence_dialoginfo \
modules/presence_mwi \
modules/presence_xcapdiff \
modules/presence_xml \
modules/proto_bin \
modules/proto_hep \
modules/proto_sctp \
modules/proto_smpp \
modules/proto_tls \
modules/proto_ws \
modules/proto_wss \
modules/pua \
modules/pua_bla \
modules/pua_dialoginfo \
modules/pua_mi \
modules/pua_usrloc \
modules/pua_xmpp \
modules/python \
modules/qos \
modules/rabbitmq \
modules/rabbitmq_consumer \
modules/ratelimit \
modules/regex \
modules/registrar \
modules/rest_client \
modules/rls \
modules/rr \
modules/rtpengine \
modules/rtpproxy \
modules/script_helper \
modules/seas \
modules/tracer \
modules/signaling \
modules/sipcapture \
modules/sip_i \
modules/sipmsgops \
modules/siprec \
modules/sl \
modules/sms \
modules/sngtc \
modules/snmpstats \
modules/speeddial \
modules/sql_cacher \
modules/sst \
modules/statistics \
modules/stun \
modules/textops \
modules/tlsops \
modules/tls_mgm \
modules/tm \
modules/topology_hiding \
modules/tracer \
modules/uac \
modules/uac_auth \
modules/uac_redirect \
modules/db_unixodbc \
modules/uri \
modules/uri_db \
modules/uri_radius \
modules/uac_registrant \
modules/userblacklist \
modules/usrloc \
modules/xlog \
modules/xcap \
modules/xcap_client \
modules/xml \
modules/xmpp \
net \
net/proto_tcp \
net/proto_udp \
parser \
parser/contact \
parser/digest \
tls \
utils
parser/sdp \
utils \
utils/coverity \
utils/db_berkeley \
utils/db_oracle \
utils/fifo_relay \
utils/opensipsunix \
utils/vim

# This tag can be used to specify the character encoding of the source files that
# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
Expand Down Expand Up @@ -786,11 +895,12 @@ HTML_FOOTER =

HTML_STYLESHEET =

### has become obsolete
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used.

HTML_ALIGN_MEMBERS = YES
#HTML_ALIGN_MEMBERS = YES

# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the
Expand Down Expand Up @@ -1026,17 +1136,19 @@ GENERATE_XML = NO

XML_OUTPUT = xml

### has become obsolete
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
# syntax of the XML files.

XML_SCHEMA =
#XML_SCHEMA =

### has become obsolete
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
# syntax of the XML files.

XML_DTD =
#XML_DTD =

# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
# dump the program listings (including syntax highlighting
Expand Down Expand Up @@ -1122,14 +1234,14 @@ SEARCH_INCLUDES = YES
# contain include files that are not input files but should be processed by
# the preprocessor.

INCLUDE_PATH =
INCLUDE_PATH = /usr/include /usr/include/linux /usr/include/c++/9.1.0/tr1

# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will
# be used.

INCLUDE_FILE_PATTERNS =
INCLUDE_FILE_PATTERNS = *.h

# The PREDEFINED tag can be used to specify one or more macro names that
# are defined before the preprocessor is started (similar to the -D option of
Expand Down Expand Up @@ -1330,7 +1442,7 @@ DOTFILE_DIRS =
# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.

DOT_GRAPH_MAX_NODES = 50
DOT_GRAPH_MAX_NODES = 80

# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
# graphs generated by dot. A depth value of 3 means that only nodes reachable
Expand Down

0 comments on commit daf5978

Please sign in to comment.