corrected documentation a bit

This commit is contained in:
2011-07-16 09:53:49 +00:00
parent 1deaac776d
commit 49abb01c3e
7 changed files with 47 additions and 61 deletions

View File

@ -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()
*/

View File

@ -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.