Things To Do

Todo

Breathe doesn’t easily support overloaded functions utilizing doxygenfunction::, need to figure out how to handle the manually declared overloaded functions. This is why set_property throws the following warnings.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/api/cpp/tracktable.core.PropertyMap.rst, line 16.)

Todo

Until breathe implements a :no-index: option to the doxygennamespace directive we can’t provide a high level view of the Tracktable namespaces since they generate 60+ warnings about duplicate declarations of various functions/structs/classes etc. Relevent Github issues can be found here: https://github.com/michaeljones/breathe/issues/378 and here: https://github.com/michaeljones/breathe/issues/405.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/api/cpp/tracktable.namespaces.rst, line 5.)

Todo

Define coding conventions for Python and C++

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/conventions.rst, line 79.)

Todo

When the “super-duper example data file” is created update this section with it’s location.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/data/acquire_data.rst, line 11.)

Todo

Add the the C++ examples

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/examples/examples.rst, line 24.)

Todo

Add documentation for C++ methods for manipulating timestamps

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/user_guides/c++/basic_classes.rst, line 71.)

Todo

Add documentation for C++ methods for manipulating base points

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/user_guides/c++/basic_classes.rst, line 79.)

Todo

Make sure recompute_speed and recompute_heading are there where appropriate

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/user_guides/c++/basic_classes.rst, line 198.)

Todo

Example of creating points algorithmically

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/user_guides/c++/input.rst, line 16.)

Todo

Add an example

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/user_guides/c++/input.rst, line 33.)

Todo

This section is out of date

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/user_guides/c++/input.rst, line 42.)

Todo

Code example

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/user_guides/c++/input.rst, line 52.)

Todo

This section is out of date

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/user_guides/c++/input.rst, line 60.)

Todo

Add an example

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/user_guides/c++/input.rst, line 95.)

Todo

Code example for annotations

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/user_guides/c++/input.rst, line 118.)

Todo

Code examples for Analysis modules

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/user_guides/c++/input.rst, line 136.)

Todo

Find the best location for this section

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/user_guides/c++/input.rst, line 137.)

Todo

Add additional/clarifying language

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/user_guides/c++/input.rst, line 138.)

Todo

Code example here

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/user_guides/python/basic_classes.rst, line 171.)

Todo

Add tracktable.script_helpers.argument_groups to the documentation

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/user_guides/python/command_line.rst, line 159.)

Todo

Document response files in full

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/v1.4.1.1/Documentation/user_guides/python/command_line.rst, line 167.)