adding documentation

targets/DOCS/Doxyfile.fapi

@@ -32,33 +32,33 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = OpenAirInterface
+PROJECT_NAME = "FAPI"
 
 # 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
 # control system is used.
 
-PROJECT_NUMBER         = 
+PROJECT_NUMBER = "1.0.0"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # 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          = "Full experimental OpenSource LTE implementation (Rel 8, partial Rel 10)"
+PROJECT_BRIEF = "Small Cell Forum originated LTE MAC scheduler API"
 
 # 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
 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
 # to the output directory.
 
-PROJECT_LOGO           = $(OPENAIR_TARGETS)/DOCS/images/oai_logo.png
+PROJECT_LOGO = 
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = $(OPENAIR_TARGETS)/DOCS/
+OUTPUT_DIRECTORY = 
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and
@@ -132,7 +132,7 @@ INLINE_INHERITED_MEMB  = NO
 # shortest path that makes the file name unique will be used
 # The default value is: YES.
 
-FULL_PATH_NAMES        = NO
+FULL_PATH_NAMES = YES
 
 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
 # Stripping is only done if one of the specified strings matches the left-hand
@@ -195,7 +195,7 @@ MULTILINE_CPP_IS_BRIEF = NO
 # documentation from any documented member that it re-implements.
 # The default value is: YES.
 
-INHERIT_DOCS           = NO
+INHERIT_DOCS = YES
 
 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
 # new page for each member. If set to NO, the documentation of a member will be
@@ -280,7 +280,7 @@ EXTENSION_MAPPING      =
 # case of backward compatibilities issues.
 # The default value is: YES.
 
-MARKDOWN_SUPPORT       = NO
+MARKDOWN_SUPPORT = YES
 
 # When enabled doxygen tries to link words that correspond to documented
 # classes, or namespaces to their corresponding documentation. Such a link can
@@ -322,7 +322,7 @@ SIP_SUPPORT            = NO
 # should set this option to NO.
 # The default value is: YES.
 
-IDL_PROPERTY_SUPPORT   = NO
+IDL_PROPERTY_SUPPORT = YES
 
 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
 # tag is set to YES, then doxygen will reuse the documentation of the first
@@ -398,7 +398,7 @@ LOOKUP_CACHE_SIZE      = 0
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = YES
+EXTRACT_ALL = NO
 
 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
 # be included in the documentation.
@@ -416,7 +416,7 @@ EXTRACT_PACKAGE        = NO
 # included in the documentation.
 # The default value is: NO.
 
-EXTRACT_STATIC         = YES
+EXTRACT_STATIC = NO
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
 # locally in source files will be included in the documentation. If set to NO
@@ -432,7 +432,7 @@ EXTRACT_LOCAL_CLASSES  = YES
 # included.
 # The default value is: NO.
 
-EXTRACT_LOCAL_METHODS  = YES
+EXTRACT_LOCAL_METHODS = NO
 
 # If this flag is set to YES, the members of anonymous namespaces will be
 # extracted and appear in the documentation as a namespace called
@@ -500,7 +500,7 @@ HIDE_SCOPE_NAMES       = NO
 # the files that are included by a file in the documentation of that file.
 # The default value is: YES.
 
-SHOW_INCLUDE_FILES     = NO
+SHOW_INCLUDE_FILES = YES
 
 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
 # grouped member an include statement to the documentation, telling the reader
@@ -526,7 +526,7 @@ INLINE_INFO            = YES
 # name. If set to NO the members will appear in declaration order.
 # The default value is: YES.
 
-SORT_MEMBER_DOCS       = NO
+SORT_MEMBER_DOCS = YES
 
 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
 # descriptions of file, namespace and class members alphabetically by member
@@ -600,7 +600,7 @@ GENERATE_BUGLIST       = YES
 # the documentation.
 # The default value is: YES.
 
-GENERATE_DEPRECATEDLIST= YES
+GENERATE_DEPRECATEDLIST = YES
 
 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
@@ -624,14 +624,14 @@ MAX_INITIALIZER_LINES  = 30
 # will mention the files that were used to generate the documentation.
 # The default value is: YES.
 
-SHOW_USED_FILES        = NO
+SHOW_USED_FILES = YES
 
 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
 # will remove the Files entry from the Quick Index and from the Folder Tree View
 # (if specified).
 # The default value is: YES.
 
-SHOW_FILES             = NO
+SHOW_FILES = YES
 
 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
 # page. This will remove the Namespaces entry from the Quick Index and from the
@@ -699,7 +699,7 @@ WARNINGS               = YES
 # will automatically be disabled.
 # The default value is: YES.
 
-WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_UNDOCUMENTED = NO
 
 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
 # potential errors in the documentation, such as not documenting some parameters
@@ -731,7 +731,7 @@ WARN_FORMAT            = "$file:$line: $text"
 # messages should be written. If left blank the output is written to standard
 # error (stderr).
 
-WARN_LOGFILE           = $(OPENAIR_TARGETS)/bin/doxy.log
+WARN_LOGFILE = 
 
 #---------------------------------------------------------------------------
 # Configuration options related to the input files
@@ -768,7 +768,7 @@ INPUT_ENCODING         = UTF-8
 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
 # *.qsf, *.as and *.js.
 
-FILE_PATTERNS          = *.h
+FILE_PATTERNS = 
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.
@@ -836,7 +836,7 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             = $(OPENAIR_TARGETS)/DOCS/images
+IMAGE_PATH = images
 
 # 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
@@ -897,7 +897,7 @@ USE_MDFILE_AS_MAINPAGE =
 # also VERBATIM_HEADERS is set to NO.
 # The default value is: NO.
 
-SOURCE_BROWSER         = YES
+SOURCE_BROWSER = NO
 
 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
 # classes and enums directly into the documentation.
@@ -981,7 +981,7 @@ VERBATIM_HEADERS       = YES
 # classes, structs, unions or interfaces.
 # The default value is: YES.
 
-ALPHABETICAL_INDEX     = NO
+ALPHABETICAL_INDEX = YES
 
 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
 # which the alphabetical index list will be split.
@@ -1172,7 +1172,7 @@ DOCSET_FEEDNAME        = "Doxygen generated docs"
 # The default value is: org.doxygen.Project.
 # This tag requires that the tag GENERATE_DOCSET is set to YES.
 
-DOCSET_BUNDLE_ID       = fr.eurecom.openairinterface
+DOCSET_BUNDLE_ID = org.doxygen.Project
 
 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
 # the documentation publisher. This should be a reverse domain-name style
@@ -1180,13 +1180,13 @@ DOCSET_BUNDLE_ID       = fr.eurecom.openairinterface
 # The default value is: org.doxygen.Publisher.
 # This tag requires that the tag GENERATE_DOCSET is set to YES.
 
-DOCSET_PUBLISHER_ID    = fr.eurecom.openairinterface
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
 
 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
 # The default value is: Publisher.
 # This tag requires that the tag GENERATE_DOCSET is set to YES.
 
-DOCSET_PUBLISHER_NAME  = EURECOM
+DOCSET_PUBLISHER_NAME = Publisher
 
 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
@@ -1211,7 +1211,7 @@ GENERATE_HTMLHELP      = NO
 # written to the html output directory.
 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
 
-CHM_FILE               = irs_openair.chm
+CHM_FILE = 
 
 # The HHC_LOCATION tag can be used to specify the location (absolute path
 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
@@ -1597,8 +1597,7 @@ PAPER_TYPE             = a4
 # If left blank no extra packages will be included.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
-EXTRA_PACKAGES         = amsmath \
-                         amssymb
+EXTRA_PACKAGES = 
 
 # 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
@@ -1614,7 +1613,7 @@ EXTRA_PACKAGES         = amsmath \
 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
-LATEX_HEADER           = $(OPENAIR_TARGETS)/DOCS/openair_header.tex
+LATEX_HEADER = 
 
 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
 # generated LaTeX document. The footer should contain everything after the last
@@ -1901,7 +1900,7 @@ ENABLE_PREPROCESSING   = YES
 # The default value is: NO.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-MACRO_EXPANSION        = YES
+MACRO_EXPANSION = NO
 
 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
 # the macro expansion is limited to the macros specified with the PREDEFINED and
@@ -1909,7 +1908,7 @@ MACRO_EXPANSION        = YES
 # The default value is: NO.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-EXPAND_ONLY_PREDEF     = YES
+EXPAND_ONLY_PREDEF = NO
 
 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
 # INCLUDE_PATH will be searched if a #include is found.
@@ -1941,81 +1940,7 @@ 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             = FAPI=1\
-		         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 \ 
-			 __attribute__(x)= 
+PREDEFINED = 
 
 # 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
@@ -2024,57 +1949,7 @@ PREDEFINED             = FAPI=1\
 # definition found in the source code.
 # 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 = 
 
 # 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
@@ -2148,7 +2023,7 @@ PERL_PATH              = /usr/bin/perl
 # powerful graphs.
 # The default value is: YES.
 
-CLASS_DIAGRAMS         = NO
+CLASS_DIAGRAMS = YES
 
 # You can define message sequence charts within doxygen comments using the \msc
 # command. Doxygen will then run the mscgen tool (see:
@@ -2170,7 +2045,7 @@ DIA_PATH               =
 # and usage relations if the target is undocumented or is not a class.
 # The default value is: YES.
 
-HIDE_UNDOC_RELATIONS   = NO
+HIDE_UNDOC_RELATIONS = YES
 
 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
 # available from the path. This tool is part of Graphviz (see:
@@ -2179,7 +2054,7 @@ HIDE_UNDOC_RELATIONS   = NO
 # set to NO
 # The default value is: NO.
 
-HAVE_DOT               = YES
+HAVE_DOT = NO
 
 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
 # to run in parallel. When set to 0 doxygen will base this on the number of
@@ -2189,7 +2064,7 @@ HAVE_DOT               = YES
 # Minimum value: 0, maximum value: 32, default value: 0.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-DOT_NUM_THREADS        = 2
+DOT_NUM_THREADS = 0
 
 # When you want a differently looking font n the dot files that doxygen
 # generates you can specify the font name using DOT_FONTNAME. You need to make
@@ -2221,7 +2096,7 @@ DOT_FONTPATH           =
 # The default value is: YES.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-CLASS_GRAPH            = NO
+CLASS_GRAPH = YES
 
 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
 # graph for each documented class showing the direct and indirect implementation
@@ -2230,14 +2105,14 @@ CLASS_GRAPH            = NO
 # The default value is: YES.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-COLLABORATION_GRAPH    = NO
+COLLABORATION_GRAPH = YES
 
 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
 # groups, showing the direct groups dependencies.
 # The default value is: YES.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-GROUP_GRAPHS           = NO
+GROUP_GRAPHS = YES
 
 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
 # collaboration diagrams in a style similar to the OMG's Unified Modeling
@@ -2275,7 +2150,7 @@ TEMPLATE_RELATIONS     = NO
 # The default value is: YES.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-INCLUDE_GRAPH          = NO
+INCLUDE_GRAPH = YES
 
 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
 # set to YES then doxygen will generate a graph for each documented file showing
@@ -2284,7 +2159,7 @@ INCLUDE_GRAPH          = NO
 # The default value is: YES.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-INCLUDED_BY_GRAPH      = NO
+INCLUDED_BY_GRAPH = YES
 
 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
 # dependency graph for every global function or class method.
@@ -2351,7 +2226,7 @@ INTERACTIVE_SVG        = NO
 # found. If left blank, it is assumed the dot tool can be found in the path.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-DOT_PATH               = /usr/bin
+DOT_PATH = 
 
 # The DOTFILE_DIRS tag can be used to specify one or more directories that
 # contain dot files that are included in the documentation (see the \dotfile