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/select.c | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'src/select.c') diff --git a/src/select.c b/src/select.c index 575fd777..f7ee424c 100644 --- a/src/select.c +++ b/src/select.c @@ -1,7 +1,9 @@ -/* select filedescriptor handling, taken from: +/*! \file select.c + * select filedescriptor handling. + * Taken from: * userspace logging daemon for the iptables ULOG target - * of the linux 2.4 netfilter subsystem. - * + * of the linux 2.4 netfilter subsystem. */ +/* * (C) 2000-2009 by Harald Welte * * This program is free software; you can redistribute it and/or modify @@ -37,9 +39,8 @@ /*! \addtogroup select * @{ * select() loop abstraction - */ - -/*! \file select.c */ + * + * \file select.c */ static int maxfd = 0; static LLIST_HEAD(osmo_fds); -- cgit v1.2.3