From 5b583dc3802fb1023eed8c246552b149fd861b25 Mon Sep 17 00:00:00 2001 From: Jeffrey Townsend Date: Wed, 31 Oct 2018 13:58:04 -0700 Subject: [PATCH] Doxygen updates. --- .../any/onlp/src/onlp/module/inc/onlp/led.h | 16 ++++++---- .../onlp/src/onlp/module/inc/onlp/onlp_dox.h | 7 +++++ .../onlp/src/onlp/module/inc/onlp/platform.h | 29 +++++++++++++++++-- .../onlp/src/onlp/module/inc/onlp/stdattrs.h | 2 +- 4 files changed, 44 insertions(+), 10 deletions(-) diff --git a/packages/base/any/onlp/src/onlp/module/inc/onlp/led.h b/packages/base/any/onlp/src/onlp/module/inc/onlp/led.h index 176dbb65..54c00206 100644 --- a/packages/base/any/onlp/src/onlp/module/inc/onlp/led.h +++ b/packages/base/any/onlp/src/onlp/module/inc/onlp/led.h @@ -17,9 +17,12 @@ * License. * * - ************************************************************ + ********************************************************//** * - * LED Management + * @file + * @brief LED Management. + * @addtogroup oid-led + * @{ * ***********************************************************/ #ifndef __ONLP_LED_H__ @@ -120,15 +123,15 @@ int onlp_led_hdr_get(onlp_oid_t id, onlp_oid_hdr_t* rv); /** * @brief Get LED information. - * @param id The LED OID + * @param id The LED OID. * @param[out] rv Receives the information structure. */ int onlp_led_info_get(onlp_oid_t id, onlp_led_info_t* rv); /** - * @brief Set the LED color - * @param id The LED OID - * @param color The color. + * @brief Set the LED mode. + * @param id The LED OID. + * @param mode The mode. . * @note Only relevant if the LED supports the color capability. */ int onlp_led_mode_set(onlp_oid_t id, onlp_led_mode_t mode); @@ -234,3 +237,4 @@ extern aim_map_si_t onlp_led_mode_desc_map[]; /* */ #endif /* __ONLP_LED_H__ */ +/* @} */ diff --git a/packages/base/any/onlp/src/onlp/module/inc/onlp/onlp_dox.h b/packages/base/any/onlp/src/onlp/module/inc/onlp/onlp_dox.h index f240e5f4..58afe695 100644 --- a/packages/base/any/onlp/src/onlp/module/inc/onlp/onlp_dox.h +++ b/packages/base/any/onlp/src/onlp/module/inc/onlp/onlp_dox.h @@ -41,6 +41,12 @@ Foobar2 @defgroup onlp-appication ONLP Application Interfaces @{ + @defgroup system-interfaces General System Interfaces + These are general system interfaces. + @{ + @defgroup platform Platform Initialization and Management + @defgroup stdattrs Standard Attribute Structures + @} @defgroup oid-interfaces General OID Interfaces These interfaces are available on all OIDs. @{ @@ -58,6 +64,7 @@ Foobar2 @defgroup oid-fan Fans @defgroup oid-psu PSUs @defgroup oid-sfp SFPs + @defgroup oid-led LEDs @defgroup oid-generic Generics @} @} diff --git a/packages/base/any/onlp/src/onlp/module/inc/onlp/platform.h b/packages/base/any/onlp/src/onlp/module/inc/onlp/platform.h index 160153ff..82eeaaa5 100644 --- a/packages/base/any/onlp/src/onlp/module/inc/onlp/platform.h +++ b/packages/base/any/onlp/src/onlp/module/inc/onlp/platform.h @@ -1,8 +1,30 @@ -/**************************************************************************//** +/************************************************************ + * * - * Platform. + * Copyright 2017 Big Switch Networks, Inc. * - *****************************************************************************/ + * Licensed under the Eclipse Public License, Version 1.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.eclipse.org/legal/epl-v10.html + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + * either express or implied. See the License for the specific + * language governing permissions and limitations under the + * License. + * + * + ********************************************************//** + * + * @file + * @brief Platform Management and Initialization + * @addtogroup platform + * @{ + * + ***********************************************************/ #ifndef __ONLP_PLATFORM_H__ #define __ONLP_PLATFORM_H__ @@ -72,3 +94,4 @@ onlp_platform_manager_daemon(const char* name, const char* logfile, int onlp_platform_debug(aim_pvs_t* pvs, int argc, char** argv); #endif /* __ONLP_PLATFORM_H__ */ +/* @} */ diff --git a/packages/base/any/onlp/src/onlp/module/inc/onlp/stdattrs.h b/packages/base/any/onlp/src/onlp/module/inc/onlp/stdattrs.h index fa97ab6c..14e98a83 100644 --- a/packages/base/any/onlp/src/onlp/module/inc/onlp/stdattrs.h +++ b/packages/base/any/onlp/src/onlp/module/inc/onlp/stdattrs.h @@ -89,7 +89,7 @@ int onlp_asset_info_free(onlp_asset_info_t* aip); */ int onlp_asset_info_to_json(onlp_asset_info_t* aip, cJSON** rv); -/* See onlplib/onie.h for the onie_info versions */ +/** See onlplib/onie.h for the onie_info versions */ #endif /* __ONLP_STDATTRS_H__ */ /* @} */