doxygen comments for OAI

Finalize the doxygen comments. Please put a note in comments when you have finished the comments in a file

Install latex package

sudo apt-get install texlive-latex-base

How to compile doxygen:

cd doxygen

mkdir build

cd build

cmake ../

make doc

The index.html document is located here:

tagets/DOCS/html/index.html

Here are the files with assignment of which file is commented by whom:

Florian Kaltenberger, Raymond Knopp

                     $(OPENAIR1_DIR)/PHY/defs.h \

                     $(OPENAIR1_DIR)/PHY/impl_defs_top.h \

                     $(OPENAIR1_DIR)/PHY/impl_defs_lte.h \

                     $(OPENAIR1_DIR)/PHY/CODING/defs.h \

                     $(OPENAIR1_DIR)/PHY/INIT/defs.h \

                     $(OPENAIR1_DIR)/PHY/TOOLS/defs.h \

                     $(OPENAIR1_DIR)/PHY/LTE_TRANSPORT/defs.h \

                     $(OPENAIR1_DIR)/PHY/LTE_TRANSPORT/proto.h \

                     $(OPENAIR1_DIR)/PHY/LTE_TRANSPORT/dci.h \

                     $(OPENAIR1_DIR)/PHY/MODULATION/defs.h \

                     $(OPENAIR1_DIR)/PHY/LTE_ESTIMATION/defs.h \

                     $(OPENAIR1_DIR)/SCHED/defs.h \

                     $(OPENAIR1_DIR)/SIMULATION/RF/defs.h \

                     $(OPENAIR1_DIR)/SIMULATION/TOOLS/defs.h \

                     $(OPENAIR1_DIR)/MAC_INTERFACE/defs.h \

Navid Nikaien, Raymond Knopp

                     $(OPENAIR2_DIR)/ENB_APP/enb_config.h \

		         $(OPENAIR2_DIR)/RRC/LITE/defs.h \

     		 $(OPENAIR2_DIR)/RRC/LITE/proto.h \

                     $(OPENAIR2_DIR)/RRC/LITE/rrc_eNB_S1AP.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_control_primitives_proto_extern.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_sequence_manager.h \

                     $(OPENAIR2_DIR)/LAYER2/PDCP_v10.1.0/pdcp_util.h \

                     $(OPENAIR2_DIR)/COMMON/platform_constants.h \

                     $(OPENAIR2_DIR)/LAYER2/MAC/defs.h \

                     $(OPENAIR2_DIR)/LAYER2/MAC/proto.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_constants.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_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_receiver.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_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_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_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_windows.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_entity.h \

                     $(OPENAIR2_DIR)/NETWORK_DRIVER/MESH/proto_extern.h \

                     $(OPENAIR_TARGETS)/ARCH/COMMON/common_lib.h

TBD by ROHIT: MOVE THE DOCS DIRECTORY FROM TARGETS TO ROOT FOLDER