DeforaNetworks/fwknop
DeforaNetworks/fwknop
3
0
Fork 0
Code Releases Activity

Add Doxygen headers to client files

Browse Source
This commit is contained in:
Jonathan Bennett 2016-01-01 02:13:21 +00:00
parent 3378ba2423
commit 9475b625a0
16 changed files with 91 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
client/cmd_opts.h
View File

@ -1,11 +1,10 @@
/*
******************************************************************************
/**
* \file client/cmd_opts.h
*
* File: cmd_opts.h
*
* Purpose: Header file for fwknop command line options.
*
* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* \brief Header file for fwknop command line options.
*/
/* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* Copyright (C) 2009-2015 fwknop developers and contributors. For a full
* list of contributors, see the file 'CREDITS'.
*

9
client/config_init.c
View File

@ -1,11 +1,10 @@
/**
******************************************************************************
*
* \file config_init.c
* \file client/config_init.c
*
* \brief Command-line and config file processing for fwknop client.
*
* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
*/
/* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* Copyright (C) 2009-2015 fwknop developers and contributors. For a full
* list of contributors, see the file 'CREDITS'.
*

11
client/config_init.h
View File

@ -1,11 +1,10 @@
/**
******************************************************************************
* \file client/config_init.h
*
* @file config_init.h
*
* @brief Header file for fwknop config_init.
*
* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* \brief Header file for fwknop config_init.
*/
/* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* Copyright (C) 2009-2015 fwknop developers and contributors. For a full
* list of contributors, see the file 'CREDITS'.
*

9
client/fwknop.c
View File

@ -1,9 +1,10 @@
/**
* @file fwknop.c
* \file client/fwknop.c
*
* @brief The fwknop client.
*
* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* \brief The fwknop client.
*/
/* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* Copyright (C) 2009-2015 fwknop developers and contributors. For a full
* list of contributors, see the file 'CREDITS'.
*

13
client/fwknop.h
View File

@ -1,11 +1,10 @@
/*
*****************************************************************************
/**
* \file client/fwknop.h
*
* File: fwknop.h
*
* Purpose: Header file for fwknop client test program.
*
* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* \brief Header file for fwknop client test program.
*/
/* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* Copyright (C) 2009-2015 fwknop developers and contributors. For a full
* list of contributors, see the file 'CREDITS'.
*

13
client/fwknop_common.h
View File

@ -1,11 +1,10 @@
/*
******************************************************************************
/**
* \file client/fwknop_common.h
*
* File: fwknop_common.h
*
* Purpose: Header file for fwknop config_init.
*
* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* \brief Header file for fwknop config_init.
*/
/* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* Copyright (C) 2009-2015 fwknop developers and contributors. For a full
* list of contributors, see the file 'CREDITS'.
*

8
client/fwknop_utests.c
View File

@ -1,3 +1,9 @@
/**
* \file client/fwknop_utests.c
*
* \brief CUnit tests for the client program
*/
#include "CUnit/Basic.h"
#include "fwknop_common.h"
@ -5,7 +11,7 @@
/**
* Register test suites from FKO files.
*
*
* The module should fetch functions according to used modules. All of them follow the same
* naming convention.
*/

13
client/getpasswd.c
View File

@ -1,11 +1,10 @@
/*
*****************************************************************************
/**
* \file client/getpasswd.c
*
* File: getpasswd.c
*
* Purpose: Routines for obtaining a password from a user.
*
* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* \brief Routines for obtaining a password from a user.
*/
/* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* Copyright (C) 2009-2015 fwknop developers and contributors. For a full
* list of contributors, see the file 'CREDITS'.
*

13
client/getpasswd.h
View File

@ -1,11 +1,10 @@
/*
*****************************************************************************
/**
* \file client/getpasswd.h
*
* File: getpasswd.h
*
* Purpose: Header file for getpasswd.c.
*
* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* \brief Header file for getpasswd.c.
*/
/* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* Copyright (C) 2009-2015 fwknop developers and contributors. For a full
* list of contributors, see the file 'CREDITS'.
*

13
client/http_resolve_host.c
View File

@ -1,12 +1,11 @@
/*
*****************************************************************************
/**
* \file client/http_resolve_host.c
*
* File: http_resolve_host.c
*
* Purpose: Routine for using an http request to obtain a client's IP
* \brief Routine for using an http request to obtain a client's IP
* address as seen from the outside world.
*
* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
*/
/* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* Copyright (C) 2009-2015 fwknop developers and contributors. For a full
* list of contributors, see the file 'CREDITS'.
*

9
client/log_msg.c
View File

@ -1,10 +1,11 @@
/**
* @file log_msg.c
* \file client/log_msg.c
*
* @brief General logging routine that can write to stderr
* \brief General logging routine that can write to stderr
* and can take variable number of args.
*
* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
*/
/* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* Copyright (C) 2009-2015 fwknop developers and contributors. For a full
* list of contributors, see the file 'CREDITS'.
*

9
client/log_msg.h
View File

@ -1,9 +1,10 @@
/**
* @file log_msg.h
* \file client/log_msg.h
*
* @brief Header file for log_msg.c
*
* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* \brief Header file for log_msg.c
*/
/* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* Copyright (C) 2009-2015 fwknop developers and contributors. For a full
* list of contributors, see the file 'CREDITS'.
*

13
client/spa_comm.c
View File

@ -1,11 +1,10 @@
/*
*****************************************************************************
/**
* \file client/spa_comm.c
*
* File: spa_comm.c
*
* Purpose: Network-related functions for the fwknop client
*
* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* \brief Network-related functions for the fwknop client
*/
/* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* Copyright (C) 2009-2015 fwknop developers and contributors. For a full
* list of contributors, see the file 'CREDITS'.
*

13
client/spa_comm.h
View File

@ -1,11 +1,10 @@
/*
*****************************************************************************
/**
* \file client/spa_comm.h
*
* File: spa_comm.h
*
* Purpose: Header file for fwknop client test program.
*
* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* \brief Header file for fwknop client test program.
*/
/* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* Copyright (C) 2009-2015 fwknop developers and contributors. For a full
* list of contributors, see the file 'CREDITS'.
*

13
client/utils.c
View File

@ -1,11 +1,10 @@
/*
*****************************************************************************
/**
* \file client/utils.c
*
* File: utils.c
*
* Purpose: General/Generic functions for the fwknop client.
*
* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* \brief General/Generic functions for the fwknop client.
*/
/* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* Copyright (C) 2009-2015 fwknop developers and contributors. For a full
* list of contributors, see the file 'CREDITS'.
*

13
client/utils.h
View File

@ -1,11 +1,10 @@
/*
*****************************************************************************
/**
* \file client/utils.h
*
* File: utils.h
*
* Purpose: Header file for utils.c client test program.
*
* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* \brief Header file for utils.c client test program.
*/
/* Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
* Copyright (C) 2009-2015 fwknop developers and contributors. For a full
* list of contributors, see the file 'CREDITS'.
*