Document libbabeltrace2's C API
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Sat, 21 Sep 2019 16:02:25 +0000 (12:02 -0400)
committerPhilippe Proulx <eeppeliteloop@gmail.com>
Mon, 20 Jan 2020 20:08:52 +0000 (15:08 -0500)
commit43c59509042845f8d42c3e99ec74d45fa2dc0908
tree5e436649f927443249639ff39a1d83208352bc30
parent1cda4ff4025e4b3f7bd2a861baa51d2113c4cbf9
Document libbabeltrace2's C API

This patch adds initial documentation for the Babeltrace 2 library's
C API using Doxygen.

The Doxygen project is located in `doc/api/libbabeltrace2`, as we can
eventually add `doc/api/libbabeltrace2-ctf-writer`.

To be able to use Doxygen's member grouping [1], I had to join some
header files (`const` and non `const` headers, for example), because
otherwise I could not get some functions in separate files to be in the
same member group in the order I want. In the end, the library user
includes `<babeltrace2/babeltrace.h>`, so how we organize the headers
exactly is not so crucial.

[1]: http://www.doxygen.nl/manual/grouping.html#memgroup

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I6d1dc2e7c5ee63fcd4220d0fd9f0931d361d2f31
Reviewed-on: https://review.lttng.org/c/babeltrace/+/2807
Tested-by: jenkins <jenkins@lttng.org>
261 files changed:
.gitignore
configure.ac
doc/api/.gitignore [deleted file]
doc/api/Doxyfile.in [deleted file]
doc/api/DoxygenLayout.xml [deleted file]
doc/api/Makefile.am
doc/api/README.adoc [deleted file]
doc/api/dox/examples-ctfir.dox [deleted file]
doc/api/dox/examples.dox [deleted file]
doc/api/dox/group-api-ref.dox [deleted file]
doc/api/dox/group-ctf-ir.dox [deleted file]
doc/api/dox/includes-build.dox [deleted file]
doc/api/dox/main-page.dox [deleted file]
doc/api/dox/quick-start.dox [deleted file]
doc/api/images/babeltrace-cli.png [deleted file]
doc/api/images/ctf-stream-packet.png [deleted file]
doc/api/images/ctf-trace.png [deleted file]
doc/api/images/ref-count-api-returns.png [deleted file]
doc/api/images/ref-count-callback.png [deleted file]
doc/api/images/ref-count-user-calls.png [deleted file]
doc/api/libbabeltrace2/.gitignore [new file with mode: 0644]
doc/api/libbabeltrace2/Doxyfile.in [new file with mode: 0644]
doc/api/libbabeltrace2/DoxygenLayout.xml [new file with mode: 0644]
doc/api/libbabeltrace2/Makefile.am [new file with mode: 0644]
doc/api/libbabeltrace2/README.adoc [new file with mode: 0644]
doc/api/libbabeltrace2/dox/api-fund.dox [new file with mode: 0644]
doc/api/libbabeltrace2/dox/examples.dox [new file with mode: 0644]
doc/api/libbabeltrace2/dox/group-trace-ir.dox [new file with mode: 0644]
doc/api/libbabeltrace2/dox/guides.dox [new file with mode: 0644]
doc/api/libbabeltrace2/dox/main-page.dox [new file with mode: 0644]
doc/api/libbabeltrace2/examples/distill.c [new file with mode: 0644]
doc/api/libbabeltrace2/examples/dust [new file with mode: 0644]
doc/api/libbabeltrace2/examples/dust.c [new file with mode: 0644]
doc/api/libbabeltrace2/examples/epitome.c [new file with mode: 0644]
doc/api/libbabeltrace2/examples/vestige-plugin.c [new file with mode: 0644]
doc/api/libbabeltrace2/images/all-field-classes.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/all-fields.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/basic-convert-graph.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/clock-terminology.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/clocks.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/complex-graph.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/component-zoom.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/component.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/darray-link.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/error-reporting-step-5.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/error-reporting-step-6.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/error-reporting-step-7.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/error-reporting-steps-1234.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/error-reporting-steps-89.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/error-reporting.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/fc-array.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/fc-ba.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/fc-bool.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/fc-enum.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/fc-int.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/fc-opt.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/fc-real.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/fc-string.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/fc-struct.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/fc-to-field.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/fc-var.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/field-class-zoom.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/graph-lifetime.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/linking.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/msg-iter-cls.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/msg-iter-complex.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/msg-iter.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/opt-link.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/plugin-comp-cls-full.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/plugin.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/trace-structure-msg-seq.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/trace-structure.png [new file with mode: 0644]
doc/api/libbabeltrace2/images/var-link.png [new file with mode: 0644]
doc/api/libbabeltrace2/style.css [new file with mode: 0644]
include/Makefile.am
include/babeltrace2/babeltrace.h
include/babeltrace2/current-thread.h [deleted file]
include/babeltrace2/error-cause-const.h [deleted file]
include/babeltrace2/error-const.h [deleted file]
include/babeltrace2/error-reporting.h [new file with mode: 0644]
include/babeltrace2/graph/component-class-const.h [deleted file]
include/babeltrace2/graph/component-class-dev.h [new file with mode: 0644]
include/babeltrace2/graph/component-class-filter-const.h [deleted file]
include/babeltrace2/graph/component-class-filter.h [deleted file]
include/babeltrace2/graph/component-class-sink-const.h [deleted file]
include/babeltrace2/graph/component-class-sink.h [deleted file]
include/babeltrace2/graph/component-class-source-const.h [deleted file]
include/babeltrace2/graph/component-class-source.h [deleted file]
include/babeltrace2/graph/component-class.h
include/babeltrace2/graph/component-const.h [deleted file]
include/babeltrace2/graph/component-descriptor-set-const.h [deleted file]
include/babeltrace2/graph/component-descriptor-set.h
include/babeltrace2/graph/component-filter-const.h [deleted file]
include/babeltrace2/graph/component-sink-const.h [deleted file]
include/babeltrace2/graph/component-source-const.h [deleted file]
include/babeltrace2/graph/component.h [new file with mode: 0644]
include/babeltrace2/graph/connection-const.h [deleted file]
include/babeltrace2/graph/connection.h [new file with mode: 0644]
include/babeltrace2/graph/graph-const.h [deleted file]
include/babeltrace2/graph/graph.h
include/babeltrace2/graph/interrupter-const.h [deleted file]
include/babeltrace2/graph/interrupter.h
include/babeltrace2/graph/message-const.h [deleted file]
include/babeltrace2/graph/message-discarded-events-const.h [deleted file]
include/babeltrace2/graph/message-discarded-events.h [deleted file]
include/babeltrace2/graph/message-discarded-packets-const.h [deleted file]
include/babeltrace2/graph/message-discarded-packets.h [deleted file]
include/babeltrace2/graph/message-event-const.h [deleted file]
include/babeltrace2/graph/message-event.h [deleted file]
include/babeltrace2/graph/message-iterator-class.h
include/babeltrace2/graph/message-iterator.h
include/babeltrace2/graph/message-message-iterator-inactivity-const.h [deleted file]
include/babeltrace2/graph/message-message-iterator-inactivity.h [deleted file]
include/babeltrace2/graph/message-packet-beginning-const.h [deleted file]
include/babeltrace2/graph/message-packet-beginning.h [deleted file]
include/babeltrace2/graph/message-packet-end-const.h [deleted file]
include/babeltrace2/graph/message-packet-end.h [deleted file]
include/babeltrace2/graph/message-stream-beginning-const.h [deleted file]
include/babeltrace2/graph/message-stream-beginning.h [deleted file]
include/babeltrace2/graph/message-stream-const.h [deleted file]
include/babeltrace2/graph/message-stream-end-const.h [deleted file]
include/babeltrace2/graph/message-stream-end.h [deleted file]
include/babeltrace2/graph/message.h [new file with mode: 0644]
include/babeltrace2/graph/mip.h [deleted file]
include/babeltrace2/graph/port-const.h [deleted file]
include/babeltrace2/graph/port-input-const.h [deleted file]
include/babeltrace2/graph/port-output-const.h [deleted file]
include/babeltrace2/graph/port.h [new file with mode: 0644]
include/babeltrace2/graph/private-query-executor.h
include/babeltrace2/graph/query-executor-const.h [deleted file]
include/babeltrace2/graph/query-executor.h
include/babeltrace2/graph/self-component-class-filter.h [deleted file]
include/babeltrace2/graph/self-component-class-sink.h [deleted file]
include/babeltrace2/graph/self-component-class-source.h [deleted file]
include/babeltrace2/graph/self-component-class.h
include/babeltrace2/graph/self-component-filter.h [deleted file]
include/babeltrace2/graph/self-component-port-input.h [deleted file]
include/babeltrace2/graph/self-component-port-output.h [deleted file]
include/babeltrace2/graph/self-component-port.h
include/babeltrace2/graph/self-component-sink.h [deleted file]
include/babeltrace2/graph/self-component-source.h [deleted file]
include/babeltrace2/graph/self-component.h
include/babeltrace2/graph/self-message-iterator.h
include/babeltrace2/integer-range-set-const.h [deleted file]
include/babeltrace2/integer-range-set.h
include/babeltrace2/logging.h
include/babeltrace2/plugin/plugin-const.h [deleted file]
include/babeltrace2/plugin/plugin-dev.h
include/babeltrace2/plugin/plugin-loading.h [new file with mode: 0644]
include/babeltrace2/plugin/plugin-set-const.h [deleted file]
include/babeltrace2/property.h [deleted file]
include/babeltrace2/trace-ir/clock-class-const.h [deleted file]
include/babeltrace2/trace-ir/clock-class.h
include/babeltrace2/trace-ir/clock-snapshot-const.h [deleted file]
include/babeltrace2/trace-ir/clock-snapshot.h [new file with mode: 0644]
include/babeltrace2/trace-ir/event-class-const.h [deleted file]
include/babeltrace2/trace-ir/event-class.h
include/babeltrace2/trace-ir/event-const.h [deleted file]
include/babeltrace2/trace-ir/event.h
include/babeltrace2/trace-ir/field-class-const.h [deleted file]
include/babeltrace2/trace-ir/field-class.h
include/babeltrace2/trace-ir/field-const.h [deleted file]
include/babeltrace2/trace-ir/field-path-const.h [deleted file]
include/babeltrace2/trace-ir/field-path.h [new file with mode: 0644]
include/babeltrace2/trace-ir/field.h
include/babeltrace2/trace-ir/packet-const.h [deleted file]
include/babeltrace2/trace-ir/packet.h
include/babeltrace2/trace-ir/stream-class-const.h [deleted file]
include/babeltrace2/trace-ir/stream-class.h
include/babeltrace2/trace-ir/stream-const.h [deleted file]
include/babeltrace2/trace-ir/stream.h
include/babeltrace2/trace-ir/trace-class-const.h [deleted file]
include/babeltrace2/trace-ir/trace-class.h
include/babeltrace2/trace-ir/trace-const.h [deleted file]
include/babeltrace2/trace-ir/trace.h
include/babeltrace2/types.h
include/babeltrace2/util.h
include/babeltrace2/value-const.h [deleted file]
include/babeltrace2/value.h
include/babeltrace2/version.h
src/bindings/python/bt2/bt2/native_bt.i
src/bindings/python/bt2/bt2/native_bt_clock_class.i
src/bindings/python/bt2/bt2/native_bt_clock_snapshot.i
src/bindings/python/bt2/bt2/native_bt_component.i
src/bindings/python/bt2/bt2/native_bt_component_class.i
src/bindings/python/bt2/bt2/native_bt_connection.i
src/bindings/python/bt2/bt2/native_bt_error.i
src/bindings/python/bt2/bt2/native_bt_event.i
src/bindings/python/bt2/bt2/native_bt_event_class.i
src/bindings/python/bt2/bt2/native_bt_field.i
src/bindings/python/bt2/bt2/native_bt_field_class.i
src/bindings/python/bt2/bt2/native_bt_field_path.i
src/bindings/python/bt2/bt2/native_bt_graph.i
src/bindings/python/bt2/bt2/native_bt_integer_range_set.i
src/bindings/python/bt2/bt2/native_bt_interrupter.i
src/bindings/python/bt2/bt2/native_bt_message.i
src/bindings/python/bt2/bt2/native_bt_mip.i
src/bindings/python/bt2/bt2/native_bt_packet.i
src/bindings/python/bt2/bt2/native_bt_plugin.i
src/bindings/python/bt2/bt2/native_bt_port.i
src/bindings/python/bt2/bt2/native_bt_query_exec.i
src/bindings/python/bt2/bt2/native_bt_stream.i
src/bindings/python/bt2/bt2/native_bt_stream_class.i
src/bindings/python/bt2/bt2/native_bt_trace.i
src/bindings/python/bt2/bt2/native_bt_trace_class.i
src/bindings/python/bt2/bt2/native_bt_value.i
src/cli/babeltrace2-cfg-cli-args.h
src/lib/graph/component-class-sink-simple.c
src/lib/graph/component-class-sink-simple.h
src/lib/graph/component-class.c
src/lib/graph/component-class.h
src/lib/graph/component-descriptor-set.c
src/lib/graph/component-filter.c
src/lib/graph/component-filter.h
src/lib/graph/component-sink.c
src/lib/graph/component-sink.h
src/lib/graph/component-source.c
src/lib/graph/component.c
src/lib/graph/component.h
src/lib/graph/connection.c
src/lib/graph/connection.h
src/lib/graph/graph.c
src/lib/graph/graph.h
src/lib/graph/iterator.c
src/lib/graph/message/discarded-items.c
src/lib/graph/message/discarded-items.h
src/lib/graph/message/event.c
src/lib/graph/message/iterator.h
src/lib/graph/message/message-iterator-inactivity.c
src/lib/graph/message/message-iterator-inactivity.h
src/lib/graph/message/message.c
src/lib/graph/message/message.h
src/lib/graph/message/packet.c
src/lib/graph/message/stream.c
src/lib/graph/message/stream.h
src/lib/graph/mip.c
src/lib/graph/port.c
src/lib/graph/port.h
src/lib/graph/query-executor.c
src/lib/plugin/plugin-so.c
src/lib/plugin/plugin.c
src/lib/plugin/plugin.h
src/lib/trace-ir/attributes.c
src/lib/trace-ir/clock-class.c
src/lib/trace-ir/clock-snapshot.c
src/lib/trace-ir/event-class.c
src/lib/trace-ir/event.c
src/lib/trace-ir/field-class.c
src/lib/trace-ir/field-path.c
src/lib/trace-ir/field-path.h
src/lib/trace-ir/field.c
src/lib/trace-ir/packet.c
src/lib/trace-ir/packet.h
src/lib/trace-ir/resolve-field-path.c
src/lib/trace-ir/resolve-field-path.h
src/lib/trace-ir/stream-class.c
src/lib/trace-ir/stream.c
src/lib/trace-ir/trace-class.c
src/lib/trace-ir/trace.c
src/plugins/lttng-utils/debug-info/trace-ir-mapping.c
src/python-plugin-provider/python-plugin-provider.c
This page took 0.044175 seconds and 4 git commands to generate.