From 49abb01c3e17b6ad18a7624a8da0b7e057bdc8e0 Mon Sep 17 00:00:00 2001 From: hyung-hwan Date: Sat, 16 Jul 2011 09:53:49 +0000 Subject: [PATCH] corrected documentation a bit --- qse/doc/page/cut.doc | 26 +++++++++++++++++++++++++- qse/doc/page/sed.doc | 4 ++-- qse/include/qse/cut/std.h | 2 +- qse/include/qse/sed/Sed.hpp | 21 ++++----------------- qse/include/qse/sed/StdSed.hpp | 5 +++-- qse/include/qse/sed/sed.h | 31 +++++++------------------------ qse/include/qse/sed/std.h | 19 +++++-------------- 7 files changed, 47 insertions(+), 61 deletions(-) diff --git a/qse/doc/page/cut.doc b/qse/doc/page/cut.doc index 8f6e20eb..9d9a5636 100644 --- a/qse/doc/page/cut.doc +++ b/qse/doc/page/cut.doc @@ -1,4 +1,28 @@ /** @defgroup cut TEXT CUTTER -Text Cutting Utility +@section cut_contents CONTENTS +- \ref cut_intro +- \ref cut_howtouse + +@section cut_intro INTRODUCTION + +Most of unix platforms offer a text utility with which you can remove +or extract selected subtext. This library contains data types and functions +that can help you embed such text manipulation functionality into your +applications. + +@section cut_howtouse HOW TO USE + +See the following key functions. + +- qse_cut_open() +- qse_cut_comp() +- qse_cut_exec() +- qse_cut_close() + +Also see a helper functions for easier use. + +- qse_cut_openstd() +- qse_cut_compstd() +- qse_cut_execstd() */ diff --git a/qse/doc/page/sed.doc b/qse/doc/page/sed.doc index fd35fae2..4a5b269f 100644 --- a/qse/doc/page/sed.doc +++ b/qse/doc/page/sed.doc @@ -7,8 +7,8 @@ @section sed_intro INTRODUCTION -The sed stream editor is a non-interactive text editing tool commonly used -on Unix environment. Sed reads text from an input stream, stores it to +A stream editor is a non-interactive text editing tool commonly used +on Unix environment. It reads text from an input stream, stores it to pattern space, manipulates the pattern space by applying a set of editing commands, and writes the pattern space to an output stream. Typically, the input and output streams are a console or a file. diff --git a/qse/include/qse/cut/std.h b/qse/include/qse/cut/std.h index c6ded9c4..cf7eeee0 100644 --- a/qse/include/qse/cut/std.h +++ b/qse/include/qse/cut/std.h @@ -28,7 +28,7 @@ * by implementing default handlers for I/O and memory management. * * @example cut01.c - * This example shows how to write a simple text cutter using easy API + * This example shows how to write a simple text cutter using helper * functions. */ diff --git a/qse/include/qse/sed/Sed.hpp b/qse/include/qse/sed/Sed.hpp index ee2b43f1..75122983 100644 --- a/qse/include/qse/sed/Sed.hpp +++ b/qse/include/qse/sed/Sed.hpp @@ -1,5 +1,5 @@ /* - * $Id: Sed.hpp 441 2011-04-22 14:28:43Z hyunghwan.chung $ + * $Id: Sed.hpp 507 2011-07-15 15:53:49Z hyunghwan.chung $ * Copyright 2006-2011 Chung, Hyung-Hwan. This file is part of QSE. @@ -24,20 +24,10 @@ #include #include -/** - * @defgroup sed_cxx C++ - * @ingroup sed - * @{ - */ - -/** - * @defgroup sed_cxx_core Core interface - * @ingroup sed_cxx - * @{ - */ - /** @file - * Stream Editor + * This file defines C++ classes that you can use when you create a stream + * editor. The C++ classes encapsulates the C data types and functions in + * a more object-oriented manner. */ ///////////////////////////////// @@ -322,7 +312,4 @@ private: QSE_END_NAMESPACE(QSE) ///////////////////////////////// -/* @} */ -/* @} */ - #endif diff --git a/qse/include/qse/sed/StdSed.hpp b/qse/include/qse/sed/StdSed.hpp index c425c37d..4d6cd88a 100644 --- a/qse/include/qse/sed/StdSed.hpp +++ b/qse/include/qse/sed/StdSed.hpp @@ -1,5 +1,5 @@ /* - * $Id: StdSed.hpp 441 2011-04-22 14:28:43Z hyunghwan.chung $ + * $Id: StdSed.hpp 507 2011-07-15 15:53:49Z hyunghwan.chung $ * Copyright 2006-2011 Chung, Hyung-Hwan. This file is part of QSE. @@ -26,7 +26,8 @@ #include /** @file - * Standard Stream Editor + * This file defines easier-to-use stream editor classes providing standard + * memory management and I/O handling. */ ///////////////////////////////// diff --git a/qse/include/qse/sed/sed.h b/qse/include/qse/sed/sed.h index d37c690a..93e1c66f 100644 --- a/qse/include/qse/sed/sed.h +++ b/qse/include/qse/sed/sed.h @@ -1,5 +1,5 @@ /* - * $Id: sed.h 441 2011-04-22 14:28:43Z hyunghwan.chung $ + * $Id: sed.h 507 2011-07-15 15:53:49Z hyunghwan.chung $ * Copyright 2006-2011 Chung, Hyung-Hwan. This file is part of QSE. @@ -24,27 +24,13 @@ #include #include -/** - * @defgroup sed_c C - * @ingroup sed - * @{ - * hello - */ - -/** - * @defgroup sed_c_core Core interface - * @ingroup sed_c - * @{ - * The sed library provides data types and functions for creating a custom - * stream editor commonly available on platforms. It is a non-interactive - * text editing tool that reads text from an input stream, stores it to - * pattern space, manipulates the pattern space by applying a set of editing - * commands, and writes the pattern space to an output stream. Typically, - * the input and output streams are a console or a file. - */ - /** @file - * A stream editor performs text transformation on a text stream. + * This file defines data types and functions to use for creating a custom + * stream editor commonly available on many platforms. A stream editor is + * a non-interactive text editing tool that reads text from an input stream, + * stores it to pattern space, manipulates the pattern space by applying a set + * of editing commands, and writes the pattern space to an output stream. + * Typically, the input and output streams are a console or a file. * * @code * sed = qse_sed_open (); @@ -442,7 +428,4 @@ void qse_sed_setlinnum ( } #endif -/* @} */ -/* @} */ - #endif diff --git a/qse/include/qse/sed/std.h b/qse/include/qse/sed/std.h index ac8c3599..fbbe00ed 100644 --- a/qse/include/qse/sed/std.h +++ b/qse/include/qse/sed/std.h @@ -21,21 +21,14 @@ #ifndef _QSE_SED_STD_H_ #define _QSE_SED_STD_H_ -/** - * @defgroup sed_c_std Helper functions - * @ingroup sed_c - * @{ - * If you don't care about the details of memory management and I/O, - * you can choose to use the helper functions provided here. It is - * a higher-level interface that is easier to use as it implements - * default handlers for I/O and memory management. - */ - #include /** @file - * This file provides easier-to-use interface - * by implementing default handlers for I/O and memory management. + * This file defines easier-to-use helper interface for a stream editor. + * If you don't care about the details of memory management and I/O handling, + * you can choose to use the helper functions provided here. It is + * a higher-level interface that is easier to use as it implements + * default handlers for I/O and memory management. * * @example sed01.c * This example shows how to write a simple stream editor using easy API @@ -104,6 +97,4 @@ int qse_sed_execstd ( } #endif -/* @} */ - #endif