Documentation improvements to layout and grouping 35/24535/12
authorMats Wichmann <mats@linux.com>
Sun, 25 Mar 2018 18:07:27 +0000 (12:07 -0600)
committerMats Wichmann <mats@linux.com>
Fri, 18 May 2018 16:56:57 +0000 (16:56 +0000)
commitc6f30d103aba994d07c252013208e4bb9f01fcf6
tree004a2b3f4568bad2be50f7c310f0126ff691cf34
parenta56770facf359c2ac341bdd2f98182fbd2efc37f
Documentation improvements to layout and grouping

All four doxyfiles are updated to current template
  (newer doxygen version) by running doxygen -u
iotivity logo is added, doxyfiles point to it
C SDK adds individual listings for (some) libraries
xml template for C SDK displays library page
  doxygen thinks these are "modules", but mostly ok
xml template also displays "pages", which causes a
  a list of deprecated elements to be displayed
Some headers are marked up for their inclusion
  in libraries (work in progress). Libraries are
  "defined" in guides/Home.txt, so far with only
  minimal definitions - need improving.
An iotivity-specific css file is added, so far
  includes markup for two new elements (aliases)
Two aliases are defined, @experimental prints a section
  indicating the feature is experimental; @sideeffect
  takes one argument and prints a section with that
  argument as the body. Intended as a way to be able
  to note e.g. if a function causes allocations that need to
  be tracked - there are no current users of this alias.
Some minor doc cleanup is included.
Cloud auth.h emits errors on processing, those were
  fixed, some doc wording added, and the prototype
  for CloudStart was removed as there is no implementation.

Change-Id: I8a434bb3cb51523129ec8e478ac45ac196cf41b5
Signed-off-by: Mats Wichmann <mats@linux.com>
27 files changed:
resource/csdk/connectivity/api/cacommon.h
resource/csdk/connectivity/api/cautilinterface.h
resource/csdk/resource-directory/include/rd_client.h
resource/csdk/resource-directory/include/rd_database.h
resource/csdk/resource-directory/include/rd_server.h
resource/csdk/routing/include/routingmanager.h
resource/csdk/routing/include/routingmanagerinterface.h
resource/csdk/routing/include/routingmessageparser.h
resource/csdk/routing/include/routingtablemanager.h
resource/csdk/routing/include/routingutility.h
resource/csdk/security/provisioning/include/cloud/auth.h
resource/csdk/stack/include/experimental/payload_logging.h
resource/csdk/stack/include/ocpayload.h
resource/csdk/stack/include/ocpresence.h
resource/csdk/stack/include/ocstack.h
resource/csdk/stack/include/ocstackconfig.h
resource/docs/c-doc/Doxyfile
resource/docs/c-doc/devdocs.doxyfile
resource/docs/c-doc/doxygenLayout.xml
resource/docs/c-doc/guides/Home.txt
resource/docs/c-doc/html/iotivity.css [new file with mode: 0644]
resource/docs/c-doc/img/iotivity.png [new file with mode: 0644]
resource/docs/cpp-doc/Doxyfile
resource/docs/cpp-doc/devdocs.doxyfile
resource/docs/cpp-doc/html/iotivity.css [new file with mode: 0644]
resource/docs/cpp-doc/img/iotivity.png [new file with mode: 0644]
resource/include/OCApi.h