aboutsummaryrefslogtreecommitdiff
path: root/src/tuberia.h
diff options
context:
space:
mode:
authorNicolas Dato <nicolas.dato@gmail.com>2025-08-07 20:34:54 -0300
committerNicolas Dato <nicolas.dato@gmail.com>2025-08-07 20:34:54 -0300
commit044a46bb3b86ee5dcd368929d5da2f4f44806e04 (patch)
tree40adb93ee0aba036a90790e177f77ad756b14664 /src/tuberia.h
parentcef8f4c5062a5d509d9bc247869431e5dec5ced3 (diff)
downloadlibtuberia-044a46bb3b86ee5dcd368929d5da2f4f44806e04.tar.gz
improving documentation
Diffstat (limited to 'src/tuberia.h')
-rw-r--r--src/tuberia.h26
1 files changed, 2 insertions, 24 deletions
diff --git a/src/tuberia.h b/src/tuberia.h
index ca5acba..6efd45e 100644
--- a/src/tuberia.h
+++ b/src/tuberia.h
@@ -35,30 +35,8 @@
*
* <em>[Source] -> [queue_1] -> [Stage_1] -> [Queue_2] -> [Stage_2] -> [...] -> [Sink]</em>
*
- * Each source, stage, and sink runs in a thread, reads from its input queue and
- * write to the output queue.
- *
- * You can omit the source and/or sink, and inject and/or retrieve elements from
- * the pipeline.
- *
- * @section building Building
- *
- * If you don't have a ./configure file, run:
- * - `autoreconf -fi`
- *
- * When you have the ./configure file, run:
- * - `./configure`
- * - `make`
- * - `make install`
- *
- * You can see some configure options with
- * - `./configure --help`
- *
- * @section using Using this library
- *
- * Include tuberia.h, and link libtuberia.a and pthread: `-ltuberia -lpthread`
- *
- * You can use: `pkg-config --cflags --libs --static tuberia`
+ * Each source, stage, and sink runs in a thread, reads from its input queue,
+ * process the element, and writes the result to the output queue.
*
* @section quick_guide Quick Guide
*