lib/hx509/doxygen.c

   1 /*
   2  * Copyright (c) 2007 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /** @mainpage Heimdal PKIX/X.509 library
  35  *
  36  * @section intro Introduction
  37  *
  38  * Heimdal libhx509 library is a implementation of the PKIX/X.509 and
  39  * related protocols.
  40  *
  41  * PKIX/X.509 is ...
  42  *
  43  *
  44  * Sections in this manual are:
  45  * - @ref page_name
  46  * - @ref page_cert
  47  * - @ref page_keyset
  48  * - @ref page_error
  49  * - @ref page_lock
  50  * - @ref page_cms
  51  * - @ref page_ca
  52  * - @ref page_revoke
  53  * - @ref page_print
  54  * - @ref page_env
  55  *
  56  * The project web page:
  57  * http://www.h5l.org/
  58  *
  59  */
  60
  61 /** @defgroup hx509 hx509 library */
  62
  63 /** @defgroup hx509_error hx509 error functions
  64  * See the @ref page_error for description and examples. */
  65 /** @defgroup hx509_cert hx509 certificate functions
  66  * See the @ref page_cert for description and examples. */
  67 /** @defgroup hx509_keyset hx509 certificate store functions
  68  * See the @ref page_keyset for description and examples. */
  69 /** @defgroup hx509_cms hx509 CMS/pkcs7 functions
  70  * See the @ref page_cms for description and examples. */
  71 /** @defgroup hx509_crypto hx509 crypto functions */
  72 /** @defgroup hx509_misc hx509 misc functions */
  73 /** @defgroup hx509_name hx509 name functions
  74  * See the @ref page_name for description and examples. */
  75 /** @defgroup hx509_revoke hx509 revokation checking functions
  76  * See the @ref page_revoke for description and examples. */
  77 /** @defgroup hx509_verify hx509 verification functions */
  78 /** @defgroup hx509_lock hx509 lock functions
  79  * See the @ref page_lock for description and examples. */
  80 /** @defgroup hx509_query hx509 query functions */
  81 /** @defgroup hx509_ca hx509 CA functions
  82  * See the @ref page_ca for description and examples. */
  83 /** @defgroup hx509_peer hx509 certificate selecting functions */
  84 /** @defgroup hx509_print hx509 printing functions */
  85 /** @defgroup hx509_env hx509 enviroment functions */