From 17518fe393a37781c84d09836256bb1a6256032b Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Tue, 20 Jun 2017 04:35:06 +0200 Subject: doxygen: unify use of \file across the board Considering the various styles and implications found in the sources, edit scores of files to follow the same API doc guidelines around the doxygen grouping and the \file tag. Many files now show a short description in the generated API doc that was so far only available as C comment. The guidelines and reasoning behind it is documented at https://osmocom.org/projects/cellular-infrastructure/wiki/Guidelines_for_API_documentation In some instances, remove file comments and add to the corresponding group instead, to be shared among several files (e.g. bitvec). Change-Id: Ifa70e77e90462b5eb2b0457c70fd25275910c72b --- src/ctrl/control_cmd.c | 5 +++-- src/ctrl/control_if.c | 5 +++-- src/ctrl/control_vty.c | 5 +++-- src/ctrl/fsm_ctrl_commands.c | 2 ++ 4 files changed, 11 insertions(+), 6 deletions(-) (limited to 'src/ctrl') diff --git a/src/ctrl/control_cmd.c b/src/ctrl/control_cmd.c index d706995f..836bb717 100644 --- a/src/ctrl/control_cmd.c +++ b/src/ctrl/control_cmd.c @@ -1,5 +1,6 @@ -/* SNMP-like status interface - * +/*! \file control_cmd.c + * SNMP-like status interface. */ +/* * (C) 2010-2011 by Daniel Willmann * (C) 2010-2011 by On-Waves * diff --git a/src/ctrl/control_if.c b/src/ctrl/control_if.c index 5d04cdfd..47efb253 100644 --- a/src/ctrl/control_if.c +++ b/src/ctrl/control_if.c @@ -1,5 +1,6 @@ -/* SNMP-like status interface - * +/*! \file control_if.c + * SNMP-like status interface. */ +/* * (C) 2010-2011 by Daniel Willmann * (C) 2010-2011 by On-Waves * diff --git a/src/ctrl/control_vty.c b/src/ctrl/control_vty.c index a67dbe28..a968bc01 100644 --- a/src/ctrl/control_vty.c +++ b/src/ctrl/control_vty.c @@ -1,5 +1,6 @@ -/* VTY configuration for Control interface - * +/*! \file control_vty.c + * VTY configuration for Control interface. */ +/* * (C) 2016 by sysmocom s.m.f.c. GmbH * * All Rights Reserved diff --git a/src/ctrl/fsm_ctrl_commands.c b/src/ctrl/fsm_ctrl_commands.c index 6c3ecde1..38fbd1e1 100644 --- a/src/ctrl/fsm_ctrl_commands.c +++ b/src/ctrl/fsm_ctrl_commands.c @@ -1,3 +1,5 @@ +/*! \file fsm_ctrl_commands.c */ + #include #include -- cgit v1.2.3