diff options
| author | Harald Welte <laforge@gnumonks.org> | 2011-08-30 11:32:56 +0200 |
|---|---|---|
| committer | Harald Welte <laforge@gnumonks.org> | 2011-08-30 11:32:56 +0200 |
| commit | d38c8b88d7b74093d0a2045173306238f8a1f80b (patch) | |
| tree | 53912638e04216d416f03c9aeac85f707d7e8a38 /src/gsm | |
| parent | c2c0ad78325196b883a8c2f76a0332a6f8f2d9bd (diff) | |
doxygen: Add main page for all three libraries
Diffstat (limited to 'src/gsm')
| -rw-r--r-- | src/gsm/gsm_utils.c | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/src/gsm/gsm_utils.c b/src/gsm/gsm_utils.c index 1fa61168..8d072a1f 100644 --- a/src/gsm/gsm_utils.c +++ b/src/gsm/gsm_utils.c @@ -22,6 +22,46 @@ * */ +/*! \mainpage libosmogsm Documentation + * + * \section sec_intro Introduction + * This library is a collection of common code used in various + * GSM related sub-projects inside the Osmocom family of projects. It + * includes A5/1 and A5/2 ciphers, COMP128v1, a LAPDm implementation, + * a GSM TLV parser, SMS utility routines as well as + * protocol definitions for a series of protocols: + * * Um L2 (04.06) + * * Um L3 (04.08) + * * A-bis RSL (08.58) + * * A-bis OML (08.59, 12.21) + * * A (08.08) + * \n\n + * Please note that C language projects inside Osmocom are typically + * single-threaded event-loop state machine designs. As such, + * routines in libosmogsm are not thread-safe. If you must use them in + * a multi-threaded context, you have to add your own locking. + * + * \section sec_copyright Copyright and License + * Copyright © 2008-2011 - Harald Welte, Holger Freyther and contributors\n + * All rights reserved. \n\n + * The source code of libosmogsm is licensed under the terms of the GNU + * General Public License as published by the Free Software Foundation; + * either version 2 of the License, or (at your option) any later + * version.\n + * See <http://www.gnu.org/licenses/> or COPYING included in the source + * code package istelf.\n + * The information detailed here is provided AS IS with NO WARRANTY OF + * ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND + * FITNESS FOR A PARTICULAR PURPOSE. + * \n\n + * + * \section sec_contact Contact and Support + * Community-based support is available at the OpenBSC mailing list + * <http://lists.osmocom.org/mailman/listinfo/openbsc>\n + * Commercial support options available upon request from + * <http://sysmocom.de/> + */ + //#include <openbsc/gsm_data.h> #include <osmocom/core/utils.h> #include <osmocom/gsm/gsm_utils.h> |