Fix line breaks in workflow.dox

NeurodataWithoutBorders · Aug 31, 2024 · c39efc1 · c39efc1
1 parent 584fa4c
commit c39efc1
Showing 1 changed file with 20 additions and 14 deletions.
diff --git a/docs/pages/userdocs/workflow.dox b/docs/pages/userdocs/workflow.dox
@@ -8,10 +8,15 @@
  * For users wanting to integrate NWB with a particular data acquisition software, here
  * we outline the steps for a single recording from file creation to saving.
  *
- * 1. Create the I/O object (e.g,.  \ref AQNWB::HDF5::HDF5IO "HDF5IO") used for writing data to the file on disk.
- * 2. Create the \ref AQNWB::NWB::RecordingContainers "RecordingContainers" object used for managing \ref AQNWB::NWB::Container "Container" objects for storing recordings.
- * 3. Create the \ref AQNWB::NWB::NWBFile "NWBFile" object used for managing and creating NWB file contents.
- * 4. Create the \ref AQNWB::NWB::Container "Container" objects (e.g., \ref AQNWB::NWB::ElectricalSeries "ElectricalSeries") used for recording and add them to the \ref AQNWB::NWB::RecordingContainers "RecordingContainers".
+ * 1. Create the I/O object (e.g,.  \ref AQNWB::HDF5::HDF5IO "HDF5IO") used for 
+ *    writing data to the file on disk.
+ * 2. Create the \ref AQNWB::NWB::RecordingContainers "RecordingContainers" object 
+ *    used for managing \ref AQNWB::NWB::Container "Container" objects for storing recordings.
+ * 3. Create the \ref AQNWB::NWB::NWBFile "NWBFile" object used for managing and creating NWB 
+ *     file contents.
+ * 4. Create the \ref AQNWB::NWB::Container "Container" objects (e.g., 
+ *    \ref AQNWB::NWB::ElectricalSeries "ElectricalSeries") used for recording and add them 
+ *    to the \ref AQNWB::NWB::RecordingContainers "RecordingContainers".
  * 5. Start the recording.
  * 6. Write data.
  * 7. Stop the recording and close the \ref AQNWB::NWB::NWBFile "NWBFile".
@@ -32,8 +37,9 @@
  *
  * \subsection create_recording_container 2. Create the RecordingContainer object.
  * 
- * Next, create a \ref AQNWB::NWB::RecordingContainers "RecordingContainers"  object to manage the different \ref AQNWB::NWB::Container "Container" objects with the datasets
- * that you would like to write data to.
+ * Next, create a \ref AQNWB::NWB::RecordingContainers "RecordingContainers"  object to manage the 
+ * different \ref AQNWB::NWB::Container "Container" objects with the datasets that you would 
+ * like to write data to.
  * 
  * \snippet tests/examples/testWorkflowExamples.cpp example_workflow_recording_containers_snippet
  * 
@@ -48,10 +54,10 @@
  * 
  * \subsection create_datasets 4. Create datasets and add to RecordingContainers.
  *
- * Next, create the different data types (e.g. \ref AQNWB::NWB::ElectricalSeries "ElectricalSeries" or other AQNWB::NWB::TimeSeries "TimeSeries")
- * that you would like to write data into. After creation, these objects are added
- * to the  \ref AQNWB::NWB::RecordingContainers "RecordingContainers"  object so that it can manage access and data writing
- * during the recording process. 
+ * Next, create the different data types (e.g. \ref AQNWB::NWB::ElectricalSeries "ElectricalSeries" 
+ * or other AQNWB::NWB::TimeSeries "TimeSeries") that you would like to write data into. After 
+ * creation, these objects are added to the  \ref AQNWB::NWB::RecordingContainers "RecordingContainers"  
+ * object so that it can manage access and data writing during the recording process. 
  * 
  * \snippet tests/examples/testWorkflowExamples.cpp example_workflow_datasets_snippet
  *
@@ -72,10 +78,10 @@
  * 
  * \subsection write_data 6. Write data.
  *
- * During the recording process, use the \ref AQNWB::NWB::RecordingContainers "RecordingContainers"  as an interface
- * to access the various  \ref AQNWB::NWB::Container "Container" object and corresponding 
- * datasets and write blocks of data to the file. Calling `flush()` on the I/O object at anytime will ensure the 
- * data is moved to disk.
+ * During the recording process, use the \ref AQNWB::NWB::RecordingContainers "RecordingContainers" 
+ * as an interface to access the various  \ref AQNWB::NWB::Container "Container" object and corresponding 
+ * datasets and write blocks of data to the file. Calling `flush()` on the I/O object at any time will 
+ * ensure the data is moved to disk.
  * 
  * \snippet tests/examples/testWorkflowExamples.cpp example_workflow_write_snippet
  *