diff --git a/common/common.h b/common/common.h index a4acf3f0..993d2923 100644 --- a/common/common.h +++ b/common/common.h @@ -1,11 +1,10 @@ -/* - ****************************************************************************** +/** + * \file common/common.h * - * File: common.h - * - * Purpose: Common header file for fwknop client and server programs. - * - * Fwknop is developed primarily by the people listed in the file 'AUTHORS'. + * \brief Common header file for fwknop client and server programs. + */ + +/* 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'. * diff --git a/common/cunit_common.c b/common/cunit_common.c index 5dfe12e1..3c05b027 100644 --- a/common/cunit_common.c +++ b/common/cunit_common.c @@ -1,3 +1,9 @@ +/** + * \file common/cunit_common.c + * + * \brief CUnit test functions + */ + #ifdef HAVE_C_UNIT_TESTS #include "cunit_common.h" diff --git a/common/cunit_common.h b/common/cunit_common.h index bdac679e..b11e9506 100644 --- a/common/cunit_common.h +++ b/common/cunit_common.h @@ -1,3 +1,9 @@ +/** + * \file common/cunit_common.h + * + * \brief header file for CUnit tests + */ + #ifndef CUNIT_COMMON_H #define CUNIT_COMMON_H diff --git a/common/fko_util.c b/common/fko_util.c index fc29c7d9..72cc2731 100644 --- a/common/fko_util.c +++ b/common/fko_util.c @@ -1,11 +1,10 @@ -/* - ***************************************************************************** +/** + * \file common/fko_util.c * - * File: fko_util.c - * - * Purpose: Provide a set of common utility functions that fwknop can use. - * - * Fwknop is developed primarily by the people listed in the file 'AUTHORS'. + * \brief Provide a set of common utility functions that fwknop can use. + */ + +/* 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'. * diff --git a/common/fko_util.h b/common/fko_util.h index 100d9982..43474697 100644 --- a/common/fko_util.h +++ b/common/fko_util.h @@ -1,11 +1,10 @@ -/* - ***************************************************************************** +/** + * \file common/fko_util.h * - * File: fko_util.h - * - * Purpose: Header for utility functions used by libfko - * - * Fwknop is developed primarily by the people listed in the file 'AUTHORS'. + * \brief Header for utility functions used by libfko + */ + +/* 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'. * diff --git a/common/netinet_common.h b/common/netinet_common.h index fe06e555..ae511bf8 100644 --- a/common/netinet_common.h +++ b/common/netinet_common.h @@ -1,13 +1,12 @@ -/* - ***************************************************************************** +/** + * \file common/netinet_common.h * - * File: netinet_common.h - * - * Purpose: Header file for common network packet structures. We roll our + * \brief Header file for common network packet structures. We roll our * own (actually copy) here in an effort to reduce the cross- - * platform "hoop-jumping" we would need to do). - * - * Fwknop is developed primarily by the people listed in the file 'AUTHORS'. + * platform "hoop-jumping" we would need to do. + */ + +/* 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'. * diff --git a/common/strlcat.c b/common/strlcat.c index b3a24f7b..d021020c 100644 --- a/common/strlcat.c +++ b/common/strlcat.c @@ -1,11 +1,10 @@ -/* - ***************************************************************************** +/** + * \file common/strlcat.c * - * File: strlcat.c - * - * Purpose: Safer string concat routine. - * - * Copyright (c) 1998 Todd C. Miller + * \brief Safer string concat routine. + */ + +/* Copyright (c) 1998 Todd C. Miller * All rights reserved. * * Redistribution and use in source and binary forms, with or without diff --git a/common/strlcpy.c b/common/strlcpy.c index 526898f1..0b38ede0 100644 --- a/common/strlcpy.c +++ b/common/strlcpy.c @@ -1,11 +1,10 @@ -/* - ***************************************************************************** +/** + * \file common/strlcpy.c * - * File: strlcpy.c - * - * Purpose: Safer string copy routine. - * - * Copyright (c) 1998 Todd C. Miller + * \brief Safer string copy routine. + */ + +/* Copyright (c) 1998 Todd C. Miller * All rights reserved. * * Redistribution and use in source and binary forms, with or without