docs: Update Doxyfiles for c-doc
authorGeorge Nash <george.nash@intel.com>
Thu, 23 Mar 2017 16:01:14 +0000 (09:01 -0700)
committerUze Choi <uzchoi@samsung.com>
Sat, 25 Mar 2017 05:27:53 +0000 (05:27 +0000)
- Only the cautilinterface.h from connectivity is currently
  intended as a public API. The documentation directly
  references values defined in cacommon.h. So cacommon.h
  is also included to prevent documentation errors.
- OPTIMIZE_OUTPUT_FOR_C has been changed to yes. This prevents
  the documentation adding things about classes and other
  documentation that does not make since in C only code.
- Updated the Home.txt. The page linked to no longer contains
  getting started guides.

Change-Id: I1bb5d42fcd1287bb0f5614ceb204b1e56f79aa2d
Signed-off-by: George Nash <george.nash@intel.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/18137
Reviewed-by: Mats Wichmann <mats@linux.com>
Reviewed-by: Phil Coval <philippe.coval@osg.samsung.com>
Tested-by: jenkins-iotivity <jenkins@iotivity.org>
Reviewed-by: Ashok Babu Channa <ashok.channa@samsung.com>
Reviewed-by: Dan Mihai <Daniel.Mihai@microsoft.com>
Reviewed-by: Uze Choi <uzchoi@samsung.com>
resource/docs/c-doc/Doxyfile
resource/docs/c-doc/devdocs.doxyfile
resource/docs/c-doc/guides/Home.txt

index 95a4f0c..816dcf2 100644 (file)
@@ -219,7 +219,7 @@ TCL_SUBST              =
 # For instance, some of the names that are used will be different. The list
 # of all members will be omitted, etc.
 
-OPTIMIZE_OUTPUT_FOR_C  = NO
+OPTIMIZE_OUTPUT_FOR_C  = YES
 
 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
 # sources only. Doxygen will then generate output that is more tailored for
@@ -670,7 +670,8 @@ INPUT                  = . \
              ../../c_common/oic_malloc/include/oic_malloc.h \
              ../../c_common/oic_string/include/oic_string.h \
              ../../c_common/oic_time/include/oic_time.h \
-             ../../csdk/connectivity/api \
+             ../../csdk/connectivity/api/cacommon.h \
+             ../../csdk/connectivity/api/cautilinterface.h \
              guides \
              ../../csdk/security/include \
              ../../csdk/security/provisioning/include \
index 73d5240..3c6695c 100644 (file)
@@ -29,7 +29,7 @@ SEPARATE_MEMBER_PAGES  = NO
 TAB_SIZE               = 4
 ALIASES                =
 TCL_SUBST              =
-OPTIMIZE_OUTPUT_FOR_C  = NO
+OPTIMIZE_OUTPUT_FOR_C  = YES
 OPTIMIZE_OUTPUT_JAVA   = NO
 OPTIMIZE_FOR_FORTRAN   = NO
 OPTIMIZE_OUTPUT_VHDL   = NO
index 4131aff..5a442ab 100644 (file)
@@ -6,7 +6,7 @@ IoTivity is an open source software framework enabling seamless device-to-device
 
 \li <a href="annotated.html"><strong>API References</strong></a><br />Provides a reference to all public APIs available to utilize the power of IoTivity.
 
-\li <a href="https://www.iotivity.org/documentation"><strong>Getting Started Guides and Tutorials</strong></a><br />Detailed getting started guides and tutorials can be found on the iotivity.org website.
+\li <a href="https://www.iotivity.org/documentation"><strong>Additional Documentation</strong></a><br />Additional API docs, links to the IoTivity Wiki, and tools; can be found on the iotivity.org website.
 
 \li <a href="https://wiki.iotivity.org"><strong>Wiki</strong></a><br />Additional documentation can be found on the IoTivity Wiki.