[latexila/wip/latexila-next] Improve doc of the LatexilaPostProcessor class



commit 08c6d476f8acea34f05b8d172bdcd040a602c5c3
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Fri Jul 11 17:38:46 2014 +0200

    Improve doc of the LatexilaPostProcessor class

 src/liblatexila/latexila-post-processor.c |    7 +++++--
 1 files changed, 5 insertions(+), 2 deletions(-)
---
diff --git a/src/liblatexila/latexila-post-processor.c b/src/liblatexila/latexila-post-processor.c
index a53b698..07f395c 100644
--- a/src/liblatexila/latexila-post-processor.c
+++ b/src/liblatexila/latexila-post-processor.c
@@ -23,8 +23,11 @@
  * @short_description: post-processor base class
  *
  * When running a build tool, a post-processor is used to filter the output to
- * display only the relevant messages. It can be the output of a build job
- * command, or a log file, etc.
+ * display only the relevant messages. The output can come from the
+ * stdout/stderr of a build job command, or the contents of a log file, etc.
+ *
+ * For the no-output post-processor type, you should not need to create a
+ * #LatexilaPostProcessor object, since the result is empty.
  */
 
 #include "latexila-post-processor.h"


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]