maki/openairinterface5g
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated to have source files included as well in html generation

Browse Source 
git-svn-id: http://svn.eurecom.fr/openair4G/trunk@7566 818b1a75-f10b-46b9-bf7c-635c3b92a50f
This commit is contained in:
Rohit Gupta
2015-06-16 10:10:26 +00:00
parent d5a098b8d4
commit ce6d8932b3
1 changed files with 239 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files
targets/DOCS/Doxyfile
+176 -55
View File
@@ -107,7 +107,7 @@ REPEAT_BRIEF = YES
# and the result, after processing the whole list, is used as the annotated # and the result, after processing the whole list, is used as the annotated
# text. Otherwise, the brief description is used as-is. If left blank, the # text. Otherwise, the brief description is used as-is. If left blank, the
# following values are used ($name is automatically replaced with the name of # following values are used ($name is automatically replaced with the name of
# the entity):The $name class, tThe $name widget, The $name file, is, provides, # the entity):The $name class, The $name widget, The $name file, is, provides,
# specifies, contains, represents, a, an and the. # specifies, contains, represents, a, an and the.
ABBREVIATE_BRIEF = ABBREVIATE_BRIEF =
@@ -743,55 +743,54 @@ WARN_LOGFILE = $(OPENAIR_TARGETS)/bin/doxy.log
# spaces. # spaces.
# Note: If this tag is empty the current directory is searched. # Note: If this tag is empty the current directory is searched.
INPUT = $(OPENAIR1_DIR)/PHY/defs.h \ INPUT = $(OPENAIR1_DIR)/PHY/defs.h \
$(OPENAIR1_DIR)/PHY/impl_defs_top.h \ $(OPENAIR1_DIR)/PHY/impl_defs_top.h \
$(OPENAIR1_DIR)/PHY/impl_defs_lte.h \ $(OPENAIR1_DIR)/PHY/impl_defs_lte.h \
$(OPENAIR1_DIR)/PHY/CODING/defs.h \ $(OPENAIR1_DIR)/PHY/CODING/defs.h \
$(OPENAIR1_DIR)/PHY/INIT/defs.h \ $(OPENAIR1_DIR)/PHY/INIT/defs.h \
$(OPENAIR1_DIR)/PHY/TOOLS/defs.h \ $(OPENAIR1_DIR)/PHY/TOOLS/defs.h \
$(OPENAIR1_DIR)/PHY/LTE_TRANSPORT/defs.h \ $(OPENAIR1_DIR)/PHY/LTE_TRANSPORT/defs.h \
$(OPENAIR1_DIR)/PHY/LTE_TRANSPORT/proto.h \ $(OPENAIR1_DIR)/PHY/LTE_TRANSPORT/proto.h \
$(OPENAIR1_DIR)/PHY/LTE_TRANSPORT/dci.h \ $(OPENAIR1_DIR)/PHY/LTE_TRANSPORT/dci.h \
$(OPENAIR1_DIR)/PHY/MODULATION/defs.h \ $(OPENAIR1_DIR)/PHY/MODULATION/defs.h \
$(OPENAIR1_DIR)/PHY/LTE_ESTIMATION/defs.h \ $(OPENAIR1_DIR)/PHY/LTE_ESTIMATION/defs.h \
$(OPENAIR1_DIR)/SCHED/defs.h \ $(OPENAIR1_DIR)/SCHED/defs.h \
$(OPENAIR1_DIR)/SIMULATION/RF/defs.h \ $(OPENAIR1_DIR)/SIMULATION/RF/defs.h \
$(OPENAIR1_DIR)/SIMULATION/TOOLS/defs.h \ $(OPENAIR1_DIR)/SIMULATION/TOOLS/defs.h \
$(OPENAIR2_DIR)/RRC/LITE/defs.h \ $(OPENAIR2_DIR)/RRC/LITE/defs.h \
$(OPENAIR2_DIR)/RRC/LITE/rrc_eNB_S1AP.h \ $(OPENAIR2_DIR)/RRC/LITE/rrc_eNB_S1AP.h \
$(OPENAIR2_DIR)/RRC/LITE/rrc_eNB_GTPV1U.h \ $(OPENAIR2_DIR)/RRC/LITE/rrc_eNB_GTPV1U.h \
$(OPENAIR2_DIR)/LAYER2/PDCP_v10.1.0/pdcp.h \ $(OPENAIR2_DIR)/LAYER2/PDCP_v10.1.0/pdcp.h \
$(OPENAIR2_DIR)/LAYER2/PDCP_v10.1.0/pdcp_control_primitives_proto_extern.h \ $(OPENAIR2_DIR)/LAYER2/PDCP_v10.1.0/pdcp_control_primitives_proto_extern.h \
$(OPENAIR2_DIR)/LAYER2/PDCP_v10.1.0/pdcp_primitives.h \ $(OPENAIR2_DIR)/LAYER2/PDCP_v10.1.0/pdcp_primitives.h \
$(OPENAIR2_DIR)/LAYER2/PDCP_v10.1.0/pdcp_proto_extern.h \ $(OPENAIR2_DIR)/LAYER2/PDCP_v10.1.0/pdcp_proto_extern.h \
$(OPENAIR2_DIR)/LAYER2/PDCP_v10.1.0/pdcp_sequence_manager.h \ $(OPENAIR2_DIR)/LAYER2/PDCP_v10.1.0/pdcp_sequence_manager.h \
$(OPENAIR2_DIR)/LAYER2/PDCP_v10.1.0/pdcp_util.h \ $(OPENAIR2_DIR)/LAYER2/PDCP_v10.1.0/pdcp_util.h \
$(OPENAIR2_DIR)/COMMON/platform_constants.h \ $(OPENAIR2_DIR)/COMMON/platform_constants.h \
$(OPENAIR1_DIR)/MAC_INTERFACE/defs.h \ $(OPENAIR1_DIR)/MAC_INTERFACE/defs.h \
$(OPENAIR2_DIR)/LAYER2/MAC/defs.h \ $(OPENAIR2_DIR)/LAYER2/MAC/defs.h \
$(OPENAIR2_DIR)/LAYER2/MAC/proto.h \ $(OPENAIR2_DIR)/LAYER2/MAC/proto.h \
$(OPENAIR2_DIR)/LAYER2/RLC/rlc.h \ $(OPENAIR2_DIR)/LAYER2/RLC/rlc.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_constants.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_constants.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_structs.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_structs.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_entity.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_entity.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_in_sdu.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_in_sdu.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_reassembly.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_reassembly.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_receiver.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_receiver.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_retransmit.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_retransmit.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_rx_list.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_rx_list.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_segment.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_segment.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_segments_holes.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_segments_holes.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_status_report.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_status_report.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_timer_poll_retransmit.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_timer_poll_retransmit.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_timer_reordering.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_timer_reordering.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_timer_status_prohibit.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_timer_status_prohibit.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_windows.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_windows.h \
$(OPENAIR2_DIR)/PHY_INTERFACE/defs.h \ $(OPENAIR2_DIR)/PHY_INTERFACE/defs.h \
$(OPENAIR2_DIR)/LAYER2/RLC/UM_v9.3.0/rlc_um.h \ $(OPENAIR2_DIR)/LAYER2/RLC/UM_v9.3.0/rlc_um.h \
$(OPENAIR2_DIR)/LAYER2/RLC/UM_v9.3.0/rlc_um_entity.h \ $(OPENAIR2_DIR)/LAYER2/RLC/UM_v9.3.0/rlc_um_entity.h \
$(OPENAIR2_DIR)/NAS/DRIVER/MESH/proto_extern.h $(OPENAIR2_DIR)/NAS/DRIVER/MESH/proto_extern.h
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -940,7 +939,7 @@ USE_MDFILE_AS_MAINPAGE =
# also VERBATIM_HEADERS is set to NO. # also VERBATIM_HEADERS is set to NO.
# The default value is: NO. # The default value is: NO.
SOURCE_BROWSER = NO SOURCE_BROWSER = YES
# Setting the INLINE_SOURCES tag to YES will include the body of functions, # Setting the INLINE_SOURCES tag to YES will include the body of functions,
# classes and enums directly into the documentation. # classes and enums directly into the documentation.
@@ -1640,7 +1639,8 @@ PAPER_TYPE = a4
# If left blank no extra packages will be included. # If left blank no extra packages will be included.
# This tag requires that the tag GENERATE_LATEX is set to YES. # This tag requires that the tag GENERATE_LATEX is set to YES.
EXTRA_PACKAGES = amsmath amssymb EXTRA_PACKAGES = amsmath \
amssymb
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
# generated LaTeX document. The header should contain everything until the first # generated LaTeX document. The header should contain everything until the first
@@ -1983,8 +1983,79 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator. # recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = OPENAIR_LTE=1 RLC_MODULE=1 RLC_C=1 RLC_MAC_C=1 RLC_RRC_C=1 RLC_AM_C=1 RLC_AM_MODULE=1 RLC_AM_REASSEMBLY_C=1 RLC_AM_IN_SDU_C=1 RLC_AM_RETRANSMIT_C=1 RLC_AM_RX_LIST_C=1 RLC_AM_SEGMENT_C=1 RLC_AM_SEGMENT_HOLES_C=1 RLC_AM_STATUS_REPORT_C=1 RLC_AM_TIMER_POLL_RETRANSMIT_C=1 RLC_AM_TIMER_POLL_REORDERING_C=1 RLC_AM_TIMER_STATUS_PROHIBIT_C=1 RLC_AM_WINDOWS_C=1 RLC_UM_MODULE=1 RLC_UM_C=1 RLC_TM_MODULE=1 RLC_UM_C=1 public_rlc(x)=x protected_rlc private_rlc(x)=x public_rlc_mac(x)=x protected_rlc_mac(x)=x private_rlc_mac(x)=x public_rlc_rrc(x)=x protected_rlc_rrc(x)=x private_rlc_rrc(x)=x public_rlc_am(x)=x protected_rlc_am(x)=x private_rlc_am(x)=x public_rlc_am_reassembly(x)=x protected_rlc_am_reassembly(x)=x private_rlc_am_reassembly(x)=x public_rlc_am_in_sdu(x)=x protected_rlc_am_in_sdu(x)=x private_rlc_am_in_sdu(x)=x private_rlc_am_receiver(x)=x protected_rlc_am_receiver(x)=x public_rlc_am_receiver(x)=x private_rlc_am_retransmit(x)=x protected_rlc_am_retransmit(x)=x public_rlc_am_retransmit(x)=x private_rlc_am_rx_list(x)=x protected_rlc_am_rx_list(x)=x public_rlc_am_rx_list(x)=x private_rlc_am_segment(x)=x protected_rlc_am_segment(x)=x public_rlc_am_segment(x)=x private_rlc_am_segments_holes(x)=x protected_rlc_am_segments_holes(x)=x public_rlc_am_segments_holes(x)=x private_rlc_am_status_report(x)=x protected_rlc_am_status_report(x)=x public_rlc_am_status_report(x)=x private_rlc_am_timer_poll_retransmit(x)=x protected_rlc_am_timer_poll_retransmit(x)=x public_rlc_am_timer_poll_retransmit(x)=x private_rlc_am_timer_reordering(x)=x protected_rlc_am_timer_reordering(x)=x public_rlc_am_timer_reordering(x)=x private_rlc_am_timer_status_prohibit(x)=x protected_rlc_am_timer_status_prohibit(x)=x public_rlc_am_timer_status_prohibit(x)=x private_rlc_am_windows(x)=x protected_rlc_am_windows(x)=x public_rlc_am_windows(x)=x public_rlc_um(x)=x protected_rlc_um(x)=x private_rlc_um(x)=x PREDEFINED = OPENAIR_LTE=1 \
RLC_MODULE=1 \
RLC_C=1 \
RLC_MAC_C=1 \
RLC_RRC_C=1 \
RLC_AM_C=1 \
RLC_AM_MODULE=1 \
RLC_AM_REASSEMBLY_C=1 \
RLC_AM_IN_SDU_C=1 \
RLC_AM_RETRANSMIT_C=1 \
RLC_AM_RX_LIST_C=1 \
RLC_AM_SEGMENT_C=1 \
RLC_AM_SEGMENT_HOLES_C=1 \
RLC_AM_STATUS_REPORT_C=1 \
RLC_AM_TIMER_POLL_RETRANSMIT_C=1 \
RLC_AM_TIMER_POLL_REORDERING_C=1 \
RLC_AM_TIMER_STATUS_PROHIBIT_C=1 \
RLC_AM_WINDOWS_C=1 \
RLC_UM_MODULE=1 \
RLC_UM_C=1 \
RLC_TM_MODULE=1 \
RLC_UM_C=1 \
public_rlc(x)=x \
protected_rlc \
private_rlc(x)=x \
public_rlc_mac(x)=x \
protected_rlc_mac(x)=x \
private_rlc_mac(x)=x \
public_rlc_rrc(x)=x \
protected_rlc_rrc(x)=x \
private_rlc_rrc(x)=x \
public_rlc_am(x)=x \
protected_rlc_am(x)=x \
private_rlc_am(x)=x \
public_rlc_am_reassembly(x)=x \
protected_rlc_am_reassembly(x)=x \
private_rlc_am_reassembly(x)=x \
public_rlc_am_in_sdu(x)=x \
protected_rlc_am_in_sdu(x)=x \
private_rlc_am_in_sdu(x)=x \
private_rlc_am_receiver(x)=x \
protected_rlc_am_receiver(x)=x \
public_rlc_am_receiver(x)=x \
private_rlc_am_retransmit(x)=x \
protected_rlc_am_retransmit(x)=x \
public_rlc_am_retransmit(x)=x \
private_rlc_am_rx_list(x)=x \
protected_rlc_am_rx_list(x)=x \
public_rlc_am_rx_list(x)=x \
private_rlc_am_segment(x)=x \
protected_rlc_am_segment(x)=x \
public_rlc_am_segment(x)=x \
private_rlc_am_segments_holes(x)=x \
protected_rlc_am_segments_holes(x)=x \
public_rlc_am_segments_holes(x)=x \
private_rlc_am_status_report(x)=x \
protected_rlc_am_status_report(x)=x \
public_rlc_am_status_report(x)=x \
private_rlc_am_timer_poll_retransmit(x)=x \
protected_rlc_am_timer_poll_retransmit(x)=x \
public_rlc_am_timer_poll_retransmit(x)=x \
private_rlc_am_timer_reordering(x)=x \
protected_rlc_am_timer_reordering(x)=x \
public_rlc_am_timer_reordering(x)=x \
private_rlc_am_timer_status_prohibit(x)=x \
protected_rlc_am_timer_status_prohibit(x)=x \
public_rlc_am_timer_status_prohibit(x)=x \
private_rlc_am_windows(x)=x \
protected_rlc_am_windows(x)=x \
public_rlc_am_windows(x)=x \
public_rlc_um(x)=x \
protected_rlc_um(x)=x \
private_rlc_um(x)=x
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # 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 # tag can be used to specify a list of macro names that should be expanded. The
@@ -1993,7 +2064,57 @@ PREDEFINED = OPENAIR_LTE=1 RLC_MODULE=1 RLC_C=1 RLC_MAC_C=1 RLC_RRC_
# definition found in the source code. # definition found in the source code.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_AS_DEFINED = public_rlc(x)=x protected_rlc(x)=x private_rlc(x)=x public_rlc_mac(x)=x protected_rlc_mac(x)=x private_rlc_mac(x)=x public_rlc_rrc(x)=x protected_rlc_rrc(x)=x private_rlc_rrc(x)=x public_rlc_am(x)=x protected_rlc_am(x)=x private_rlc_am(x)=x public_rlc_am_reassembly(x)=x protected_rlc_am_reassembly(x)=x private_rlc_am_reassembly(x)=x public_rlc_am_in_sdu(x)=x protected_rlc_am_in_sdu(x)=x private_rlc_am_in_sdu(x)=x private_rlc_am_receiver(x)=x protected_rlc_am_receiver(x)=x public_rlc_am_receiver(x)=x private_rlc_am_retransmit(x)=x protected_rlc_am_retransmit(x)=x public_rlc_am_retransmit(x)=x private_rlc_am_rx_list(x)=x protected_rlc_am_rx_list(x)=x public_rlc_am_rx_list(x)=x private_rlc_am_segment(x)=x protected_rlc_am_segment(x)=x public_rlc_am_segment(x)=x private_rlc_am_segments_holes(x)=x protected_rlc_am_segments_holes(x)=x public_rlc_am_segments_holes(x)=x private_rlc_am_status_report(x)=x protected_rlc_am_status_report(x)=x public_rlc_am_status_report(x)=x private_rlc_am_timer_poll_retransmit(x)=x protected_rlc_am_timer_poll_retransmit(x)=x public_rlc_am_timer_poll_retransmit(x)=x private_rlc_am_timer_reordering(x)=x protected_rlc_am_timer_reordering(x)=x public_rlc_am_timer_reordering(x)=x private_rlc_am_timer_status_prohibit(x)=x protected_rlc_am_timer_status_prohibit(x)=x public_rlc_am_timer_status_prohibit(x)=x private_rlc_am_windows(x)=x protected_rlc_am_windows(x)=x public_rlc_am_windows(x)=x public_rlc_um(x)=x protected_rlc_um(x)=x private_rlc_um(x)=x EXPAND_AS_DEFINED = public_rlc(x)=x \
protected_rlc(x)=x \
private_rlc(x)=x \
public_rlc_mac(x)=x \
protected_rlc_mac(x)=x \
private_rlc_mac(x)=x \
public_rlc_rrc(x)=x \
protected_rlc_rrc(x)=x \
private_rlc_rrc(x)=x \
public_rlc_am(x)=x \
protected_rlc_am(x)=x \
private_rlc_am(x)=x \
public_rlc_am_reassembly(x)=x \
protected_rlc_am_reassembly(x)=x \
private_rlc_am_reassembly(x)=x \
public_rlc_am_in_sdu(x)=x \
protected_rlc_am_in_sdu(x)=x \
private_rlc_am_in_sdu(x)=x \
private_rlc_am_receiver(x)=x \
protected_rlc_am_receiver(x)=x \
public_rlc_am_receiver(x)=x \
private_rlc_am_retransmit(x)=x \
protected_rlc_am_retransmit(x)=x \
public_rlc_am_retransmit(x)=x \
private_rlc_am_rx_list(x)=x \
protected_rlc_am_rx_list(x)=x \
public_rlc_am_rx_list(x)=x \
private_rlc_am_segment(x)=x \
protected_rlc_am_segment(x)=x \
public_rlc_am_segment(x)=x \
private_rlc_am_segments_holes(x)=x \
protected_rlc_am_segments_holes(x)=x \
public_rlc_am_segments_holes(x)=x \
private_rlc_am_status_report(x)=x \
protected_rlc_am_status_report(x)=x \
public_rlc_am_status_report(x)=x \
private_rlc_am_timer_poll_retransmit(x)=x \
protected_rlc_am_timer_poll_retransmit(x)=x \
public_rlc_am_timer_poll_retransmit(x)=x \
private_rlc_am_timer_reordering(x)=x \
protected_rlc_am_timer_reordering(x)=x \
public_rlc_am_timer_reordering(x)=x \
private_rlc_am_timer_status_prohibit(x)=x \
protected_rlc_am_timer_status_prohibit(x)=x \
public_rlc_am_timer_status_prohibit(x)=x \
private_rlc_am_windows(x)=x \
protected_rlc_am_windows(x)=x \
public_rlc_am_windows(x)=x \
public_rlc_um(x)=x \
protected_rlc_um(x)=x \
private_rlc_um(x)=x
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
# remove all refrences to function-like macros that are alone on a line, have an # remove all refrences to function-like macros that are alone on a line, have an