Fix #50 Update docs to fix Doxygen build warnings

README.md

@@ -41,7 +41,7 @@ multi-configuration generator:
 cmake --install build --config Release
 ```
 
-# Developing
+## Developing
 
 Build system targets that are only useful for developers of this project are
 hidden if the `aq-nwb_DEVELOPER_MODE` option is disabled. Enabling this
@@ -78,7 +78,7 @@ cmake --build --preset=dev --target=<name of the target>
 
 # Code of Conduct
 
-This project and everyone participating in it is govered by our [code of conduct guidelines](./.github/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+This project and everyone participating in it is govered by our [code of conduct guidelines](https://github.com/NeurodataWithoutBorders/aqnwb/blob/main/.github/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
 
 # LICENSE
 
@@ -132,4 +132,4 @@ of Energy and the U.S. Government consequently retains certain rights.  As
 such, the U.S. Government has been granted for itself and others acting on
 its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the
 Software to reproduce, distribute copies to the public, prepare derivative 
-works, and perform publicly and display publicly, and to permit others to do so.
+works, and perform publicly and display publicly, and to permit others to do so.

src/BaseIO.hpp

@@ -291,7 +291,6 @@ class BaseIO
   /**
    * @brief Convenience function for creating timestamp related attributes.
    * @param path The location of the object in the file.
-   * @param interval Value is '1'
    * @return The status of the operation.
    */
   Status createTimestampsAttributes(const std::string& path);

src/nwb/NWBFile.hpp

@@ -56,6 +56,9 @@ class NWBFile
   /**
    * @brief Create ElectricalSeries objects to record data into.
    * Created objects are stored in recordingContainers.
+   * @param recordingArrays vector of ChannelVector indicating the electrodes to 
+   *                        record from. A seperate ElectricalSeries will be 
+   *                        created for each ChannelVector
    * @param dataType The data type of the elements in the data block.
    * @return Status The status of the object creation operation.
    */
@@ -84,8 +87,7 @@ class NWBFile
   const std::string HDMFExperimentalVersion = "0.5.0";
 
   /**
-   * @brief Gets the TimeSeries object from the recording containers
-   * @param containerName The name of the timeseries group.
+   * @brief Gets the TimeSeries object from the recordingContainers
    * @param timeseriesInd The index of the timeseries dataset within the group.
    */
   TimeSeries* getTimeSeries(const SizeType& timeseriesInd);

src/nwb/NWBRecording.hpp

@@ -38,7 +38,9 @@ class NWBRecording
    * @param baseName The base name of the file (will be appended with
    * experiment number).
    * @param experimentNumber The experiment number.
-   * @param recordingNumber The recording number.
+   * @param recordingArrays ChannelVector objets indicating the electrodes to use for 
+   *                        ElectricalSeries recordings 
+   * @param IOType Type of backend IO to use
    */
   Status openFile(const std::string& rootFolder,
                   const std::string& baseName,

src/nwb/base/TimeSeries.hpp

@@ -17,8 +17,21 @@ class TimeSeries : public Container
    * @brief Constructor.
    * @param path The location of the TimeSeries in the file.
    * @param io A shared pointer to the IO object.
+   * @param dataType The data type to use for storing the recorded voltage signal
+   * @param unit Unit for the electrical signal. Must be "volts"
    * @param description The description of the TimeSeries.
    * @param comments Human-readable comments about the TimeSeries
+   * @param dsetSize Intial size of the main dataset. This must be a vector with two
+   *                 elements. The first element specifies the lenght in time and
+   *                 the second element must be equal to the lenght of channelVector
+   * @param chunkSize Chunk size to use. The number of elements must be two to 
+   *                 specify the size of a chunk in the time and electrode dimension
+   * @param conversion Scalar to multiply each element in data to convert it to 
+   *                 the specified ‘unit’
+   * @param resolution Smallest meaningful difference between values in data, stored 
+   *                 in the specified by unit
+   * @param offset Scalar to add to the data after scaling by ‘conversion’ to finalize
+   *                 its coercion to the specified ‘unit'
    */
   TimeSeries(const std::string& path,
              std::shared_ptr<BaseIO> io,

src/nwb/ecephys/ElectricalSeries.hpp

@@ -18,9 +18,22 @@ class ElectricalSeries : public TimeSeries
    * @brief Constructor.
    * @param path The location of the ElectricalSeries in the file.
    * @param io A shared pointer to the IO object.
+   * @param dataType The data type to use for storing the recorded voltage signal
+   * @param channelVector The electrodes to use for recording
+   * @param electrodesTablePath Path to the electrodes table
+   * @param unit Unit for the electrical signal. Must be "volts". 
    * @param description The description of the TimeSeries.
-   * @param electrodesTablePath Location of the ElectrodesTable this time series
-   * was generated from
+   * @param dsetSize Intial size of the main dataset. This must be a vector with two
+   *                 elements. The first element specifies the lenght in time and
+   *                 the second element must be equal to the lenght of channelVector
+   * @param chunkSize Chunk size to use. The number of elements must be two to 
+   *                 specify the size of a chunk in the time and electrode dimension
+   * @param conversion Scalar to multiply each element in data to convert it to 
+   *                 the specified ‘unit’
+   * @param resolution Smallest meaningful difference between values in data, stored 
+   *                 in the specified by unit
+   * @param offset Scalar to add to the data after scaling by ‘conversion’ to finalize
+   *                 its coercion to the specified ‘unit'
    */
   ElectricalSeries(const std::string& path,
                    std::shared_ptr<BaseIO> io,

src/nwb/file/ElectrodeTable.hpp

@@ -19,7 +19,6 @@ class ElectrodeTable : public DynamicTable
    * @brief Constructor.
    * @param path The path of the table.
    * @param io The shared pointer to the BaseIO object.
-   * @param channels The vector of channel numbers.
    * @param description The description of the table (default: "metadata about
    * extracellular electrodes").
    */

src/nwb/hdmf/table/DynamicTable.hpp

@@ -64,7 +64,6 @@ class DynamicTable : public Container
 
   /**
    * @brief Adds a column of element identifiers to the table.
-   * @param idDescription The description of the column.
    * @param elementIDs A unique pointer to the `ElementIdentifiers` dataset.
    * @param values The vector of id values.
    */