General: code modernization using clang-tidy
[marnav.git] / doc / directories.dox
blobb95ce2693c4ddf2a78347e2339eb49e3c07f167b
1 /***
3 \dir bin
4 \brief Helper scripts.
7 \dir cmake
8 \brief Contains CMake modules.
11 \dir doc
12 \brief Home of the documentation.
14 Everything that is not in the README.md or generated from sources.
17 \dir examples
18 \brief Location of all examples using the library.
21 \dir extern
22 \brief Contains external dependencies, contained as part of the
23 repository.
26 \dir include
27 \brief Public header files.
30 \dir src
31 \brief Contains the source of the library.
34 \dir src/marnav/ais
35 \brief All AIS related classes (messages, utilities, etc.).
37 All AIS related stuff. Note that despite the AIS builds on
38 the NMEA protocol (`VDM`, `VDO` sentences), the package does not
39 have any dependencies to the `nmea` package.
42 \dir src/marnav/geo
43 \brief Collection of geographic and geodesic functions.
46 \dir src/marnav/math
47 \brief Generic math stuff.
50 \dir src/marnav/nmea
51 \brief All NMEA-0183 related classes (sentences, utilities, etc.)
54 \dir src/marnav/seatalk
55 \brief Everything SeaTalk-1 related.
58 \dir src/marnav/utils
59 \brief Common utilities.
62 \dir src/marnav-io
63 \brief Input/Output stuff to communicate with the outside world.
65 Input output stuff, mainly for NMEA and SeaTalk. Please note,
66 that this package is not mandatory. It is perfectly fine
67 to use the `nmea` package without `io`.
70 \dir test
71 \brief Contains all tests.
73 This directory contains all unit tests as well as integration tests,
74 which are executed on continuous integration builds. Examples are to
75 be found in the directory examples.