Changeset 411

Show
Ignore:
Timestamp:
04/27/06 16:51:58
Author:
rachel
Message:

Get some doxygen documentation from this file

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • openpgpsdk/trunk/src/armour.c

    r388 r411  
     1/** \file 
     2 * \brief Code for dealing with ASCII-armoured packets 
     3 */ 
     4 
    15#include <openpgpsdk/configure.h> 
    26#include <openpgpsdk/armour.h> 
    …… 
    1519#define CRC24_POLY 0x1864cfbL 
    1620 
     21/** 
     22 * \struct 
     23 */ 
    1724typedef struct 
    1825    { 
    …… 
    164171    } 
    165172 
     173/** 
     174 * \param ops_headers_t 
     175 * \param key 
     176 * 
     177 * \return header value if found, otherwise NULL 
     178 */ 
    166179const char *ops_find_header(ops_headers_t *headers,const char *key) 
    167180    { 
    …… 
    174187    } 
    175188 
     189/** 
     190 * \param dest 
     191 * \param src 
     192 */ 
    176193void ops_dup_headers(ops_headers_t *dest,const ops_headers_t *src) 
    177194    { 
    …… 
    736753    } 
    737754 
     755/** 
     756 * \param parse_info 
     757 * \param without_gap 
     758 * \param no_gap 
     759 * \param trailing_whitespace 
     760 */ 
    738761void ops_reader_push_dearmour(ops_parse_info_t *parse_info, 
    739762                              ops_boolean_t without_gap, 
    …… 
    752775    } 
    753776 
     777/** 
     778 * \param parse_info 
     779 */ 
    754780void ops_reader_pop_dearmour(ops_parse_info_t *parse_info) 
    755781    { 
    …… 
    759785    } 
    760786 
     787/** 
     788 * \struct 
     789 */ 
    761790typedef struct 
    762791    { 
    …… 
    821850    } 
    822851 
     852/** 
     853 * \param winfo 
     854 */ 
    823855void dash_escaped_destroyer(ops_writer_info_t *winfo) 
    824856    { 
    …… 
    830862 
    831863// XXX: should return errors. 
     864/** 
     865 * \param info 
     866 * \param sig 
     867 * \todo should return errors 
     868 */ 
    832869void ops_writer_push_dash_escaped(ops_create_info_t *info, 
    833870                                  ops_create_signature_t *sig) 
    …… 
    846883    } 
    847884 
     885/** 
     886 * \struct 
     887 */ 
    848888typedef struct 
    849889    { 
    …… 
    936976    return ops_stacked_write(trailer,sizeof trailer-1,errors,winfo); 
    937977    } 
     978 
     979/** 
     980 * \struct 
     981 */ 
    938982typedef struct 
    939983    { 
    …… 
    9701014 
    9711015// XXX: should return errors. 
     1016/** 
     1017 * \param info 
     1018 */ 
    9721019void ops_writer_switch_to_signature(ops_create_info_t *info) 
    9731020    {