Missing "throws" documentation in rosbag2_cpp writer open()

[gDorndorf]

Description

The documentation of rosbag2_cpp/include/writer.hpp and rosbag2_cpp/include/rosbag2_cpp/writers/sequential_writer.hpp are missing an entry that indicates that it may throw.

Missing documentation:

rosbag2/rosbag2_cpp/include/rosbag2_cpp/writer.hpp

Line 78 in ce918b7

void open(const std::string & uri);

rosbag2/rosbag2_cpp/include/rosbag2_cpp/writer.hpp

Line 87 in ce918b7

void open(

Expected Behavior

Something like this in writer.hpp and sequential_writer.hpp:

   *
   * \param storage_options Options to configure the storage
   * \param converter_options options to define in which format incoming messages are stored
+   * \throws runtime_error if 
+   * database directory already exists,
+   * failed to create database directory,
+   * no storage could be initialized,
+   * invalid bag splitting size given,
+   * max cache size less or equal 0 when snapshot mode is enabled.
   **/
  void open(
    const rosbag2_storage::StorageOptions & storage_options,

Actual Behavior

Missing documentation.

Additional context

The instances where it throws are:

rosbag2/rosbag2_cpp/src/rosbag2_cpp/writers/sequential_writer.cpp

Line 122 in ce918b7

throw std::runtime_error{error.str()};

rosbag2/rosbag2_cpp/src/rosbag2_cpp/writers/sequential_writer.cpp

Line 129 in ce918b7

throw std::runtime_error{error.str()};

rosbag2/rosbag2_cpp/src/rosbag2_cpp/writers/sequential_writer.cpp

Line 135 in ce918b7

throw std::runtime_error("No storage could be initialized. Abort");

rosbag2/rosbag2_cpp/src/rosbag2_cpp/writers/sequential_writer.cpp

Line 145 in ce918b7

throw std::runtime_error{error.str()};

rosbag2/rosbag2_cpp/src/rosbag2_cpp/writers/sequential_writer.cpp

Line 150 in ce918b7

throw std::runtime_error(

[emersonknapp]

Good eye! Left a comment about contributing but it looks like you actually did open a PR - I'll link it to this issue so that's more obvious. For future reference you can mention any issue in a PR description and that will do the necessary cross-linking, very useful. For example, "Closes #1788" is what I'm going to add to yours.