Commit 51be7aba authored by George Nash's avatar George Nash Committed by Kishen Maloor

Document oc_api.h functions

Updated doxygen.ini to not have a PROJECT_NUMBER in its output

Clean up the already documented functions.
 - removed the un-needed @brief since the doxygen is configured to use auto brief
 - added [in], [out], and [in,out] to the parameters
 - cleaned up some spacing of text so it fit in the 80 characters width
 - added "()" to the function names referenced in the documentation this allows
   doxygen to automatically link to the documentation for that function
 - removed the @c or \c and replaced it with the markdown variant `` for fixed
   width text in the generated documentation

Add documentation for the following functions:
 - oc_new_collection
 - oc_delete_collection
 - oc_new_link
 - oc_delete_link
 - oc_link_add_rel
 - oc_link_add_link_param
 - oc_collection_add_link
 - oc_collection_remove_link
 - oc_collection_get_links
 - oc_add_collection
 - oc_collection_get_collections
 - oc_collection_add_supported_rt
 - oc_collection_add_mandatory_rt
 - oc_set_con_write_cb
 - oc_init_query_iterator
 - oc_iterate_query
 - oc_iterate_query_get_values
 - oc_get_query_value
 - oc_send_response
 - oc_ignore_request
 - oc_indicate_separate_response
 - oc_set_separate_response_buffer
 - oc_send_separate_response
 - oc_notify_observers
 - oc_do_site_local_ipv6_discovery
 - oc_do_site_local_ipv6_discovery_all
 - oc_do_realm_local_ipv6_discovery
 - oc_do_realm_local_ipv6_discovery_all
 - oc_do_ip_discovery
 - oc_do_ip_discovery_all
 - oc_do_ip_discovery_at_endpoint
 - oc_do_ip_discovery_all_at_endpoint
Signed-off-by: George Nash's avatarGeorge Nash <george.nash@intel.com>
parent 3fa1688c
Pipeline #884 passed with stage
in 7 minutes and 41 seconds
This diff is collapsed.
......@@ -38,7 +38,7 @@ PROJECT_NAME = IoTivity-Lite
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 1.0
PROJECT_NUMBER =
# 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
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment