From 12635339c5874558f7799a5ee469c0a514ce070d Mon Sep 17 00:00:00 2001 From: Ed Hartnett Date: Tue, 12 Mar 2019 10:11:07 -0600 Subject: [PATCH] example documentation cleanup --- examples/C/pres_temp_4D_rd.c | 34 +++++++++++++++++----------------- examples/C/pres_temp_4D_wr.c | 20 +++++++++++--------- examples/C/quick_large_files.c | 24 ++++++++++++------------ 3 files changed, 40 insertions(+), 38 deletions(-) diff --git a/examples/C/pres_temp_4D_rd.c b/examples/C/pres_temp_4D_rd.c index 7b41e260c..72b933fbc 100644 --- a/examples/C/pres_temp_4D_rd.c +++ b/examples/C/pres_temp_4D_rd.c @@ -1,20 +1,20 @@ -/*! \file -Example program for reading a 4D netCDF file - -\ingroup tutorial - -This is an example which reads some 4D pressure and temperatures. The -data file read by this program is produced by the companion program -pres_temp_4D_wr.c. It is intended to illustrate the use of the netCDF -C API. - -This is part of the netCDF package. Copyright 2006-2011 University -Corporation for Atmospheric Research/Unidata. See COPYRIGHT file for -conditions of use. Full documentation of the netCDF can be found at -http://www.unidata.ucar.edu/software/netcdf/docs. - -\author Ed Hartnett -*/ +/* Copyright 2006-2011 University Corporation for Atmospheric +Research/Unidata. See COPYRIGHT file for conditions of use. */ +/** + * @file + * @ingroup tutorial + * Example program for reading a 4D netCDF file + * + * This is an example which reads some 4D pressure and + * temperatures. The data file read by this program is produced by the + * companion program pres_temp_4D_wr.c. It is intended to illustrate + * the use of the netCDF C API. + * + * This is part of the netCDF package. Full documentation of the netCDF can be found at + * http://www.unidata.ucar.edu/software/netcdf/docs. + * + * @author Ed Hartnett + */ #include #include diff --git a/examples/C/pres_temp_4D_wr.c b/examples/C/pres_temp_4D_wr.c index 5ba58850b..571bc621a 100644 --- a/examples/C/pres_temp_4D_wr.c +++ b/examples/C/pres_temp_4D_wr.c @@ -1,14 +1,16 @@ /* Copyright 2018 University Corporation for Atmospheric Research/Unidata. See COPYRIGHT file for conditions of use. */ -/*! \file -A more complex example of writing a netCDF file. - -This is an example program which writes some 4D pressure and -temperatures. It is intended to illustrate the use of the netCDF C -API. The companion program pres_temp_4D_rd.c shows how to read the -netCDF data file created by this program. - -\author Ed Hartnett +/** + * @file + * @ingroup tutorial + * A more complex example of writing a netCDF file. + * + * This is an example program which writes some 4D pressure and + * temperatures. It is intended to illustrate the use of the netCDF C + * API. The companion program pres_temp_4D_rd.c shows how to read the + * netCDF data file created by this program. + * + * @author Ed Hartnett */ #include diff --git a/examples/C/quick_large_files.c b/examples/C/quick_large_files.c index 17b9f38f9..f50f0809b 100644 --- a/examples/C/quick_large_files.c +++ b/examples/C/quick_large_files.c @@ -1,18 +1,18 @@ /* Copyright 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018 University Corporation for -Atmospheric Research/Unidata. - -See \ref copyright file for more info. */ -/*! \file - - This example program is part of Unidata's netCDF library for - scientific data access. - - This program (quickly, but not thoroughly) tests the large file - features. - - Ed Hartnett, 8/11/4 +Atmospheric Research/Unidata. See \ref copyright file for more +info. */ +/** + * @file + * + * This example program is part of Unidata's netCDF library for + * scientific data access. + * + * This program (quickly, but not thoroughly) tests the large file + * features. + * + * @author Ed Hartnett, 8/11/4 */ #include