diff options
| -rw-r--r-- | README.md | 22 | ||||
| -rw-r--r-- | doc/Doxyfile.in | 4 | ||||
| -rw-r--r-- | src/tuberia.h | 26 |
3 files changed, 21 insertions, 31 deletions
@@ -24,17 +24,19 @@ SOFTWARE. ## About -libtuberia: a library to implement a pipeline +libtuberia: a library to implement a pipeline. A pipeline would be: *[Source] -> [queue_1] -> [Stage_1] -> [Queue_2] -> [Stage_2] -> [...] -> [Sink]* -Each source, stage, and sink runs in a thread, reads from its imput queue and -write to the output queue +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. -You can omit the source and sink, and inject or retrieve elements from the -pipeline +This project is available: +* At my personal website: <https://ndato.com/projects/libtuberia/> +* At Savannah: <https://savannah.nongnu.org/projects/libtuberia/> +You can submit bugs at Savannah. ## Building, Compiling, Installing @@ -58,7 +60,15 @@ Include tuberia.h, and link libtuberia.a and pthread: `-ltuberia -lpthread` You can also use: `pkg-config --cflags --libs --static tuberia` -## Quick Guide +## Documentation + +The `src/tuberia.h` file has every structure and function documented. + +And if you had [Doxygen](https://www.doxygen.nl) when installing libtuberia, a +man page `tuberia.h` is also installed (you can read it with `man tuberia.h`) +and a .html is installed in `/usr/doc/libtuberia/doxygen_html/index.html`. + +### Quick Guide See the files `example/simple.c` and `example/decode_resize_encode.c` (function `do_tuberia()` in particular) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index e95ca9c..577408b 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1,3 +1,5 @@ +# @configure_input@ + # Copyright (C) 2025 Nicolas Dato # # Permission is hereby granted, free of charge, to any person obtaining a copy @@ -27,7 +29,7 @@ CASE_SENSE_NAMES = NO HIDE_SCOPE_NAMES = YES INPUT = @srcdir@/../src/tuberia.h RECURSIVE = YES -EXAMPLE_PATTERNS = *.c +JAVADOC_AUTOBRIEF = YES SOURCE_BROWSER = YES HTML_OUTPUT = @builddir@/doxygen_html GENERATE_TREEVIEW = YES 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 * |