Doxygen updates.

This commit is contained in:
Jeffrey Townsend
2018-10-31 13:58:04 -07:00
parent fe94151850
commit 5b583dc380
4 changed files with 44 additions and 10 deletions

View File

@@ -17,9 +17,12 @@
* License.
*
* </bsn.cl>
************************************************************
********************************************************//**
*
* 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[];
/* <auto.end.enum(tag:led).supportheader> */
#endif /* __ONLP_LED_H__ */
/* @} */

View File

@@ -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
@}
@}

View File

@@ -1,8 +1,30 @@
/**************************************************************************//**
/************************************************************
* <bsn.cl fy=2017 v=onl>
*
* 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.
*
* </bsn.cl>
********************************************************//**
*
* @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__ */
/* @} */

View File

@@ -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__ */
/* @} */