Arbitrary comment cleanup

include/esc/io.hpp

@@ -61,7 +61,6 @@ concept Writable = std::convertible_to<T, char32_t> ||
 
 /**
  * Write any number of writable objects to the console, in parameter order.
- *
  * @tparam Args The types of the objects to write.
  * @param args The objects to write.
  */
@@ -72,8 +71,6 @@ auto write(Args&&... args) -> void
     (write(args), ...);
 }
 
-/// Send all buffered bytes from calls to write(...) to the console device.
-
 /**
  * Flush the stdout buffer.
  * @details Sends all buffered bytes from calls to write(...) to the console.
@@ -88,9 +85,6 @@ auto flush() -> void;
  */
 auto read() -> Event;
 
-/// Read a single input Event from stdin, with timeout.
-/** Returns std::nullopt if timeout passes without an Event. */
-
 /**
  * Timeout version of read().
  * @param millisecond_timeout The maximum time to wait for input.

include/esc/key.hpp

@@ -239,7 +239,9 @@ enum class Key : char32_t {
  * The Mod enum is used to represent modifier keys on a keyboard.
  *
  * @details It is designed to be used with the Key enum to represent key
- * combinations.
+ * combinations. These are only generated when KeyMode::Raw is set. In
+ * KeyMode::Normal these not seen as separate keys, for instance ctrl + a is
+ * seen as Key::StartOfHeading and shift + a is seen as Key::A.
  */
 enum class Mod : std::underlying_type_t<Key> {
     // Last bit of unicode currently used is (1 << 20).

src/io.cpp

@@ -371,9 +371,6 @@ using Token = std::variant<ControlSequence, Escaped, UTF8, Window>;
 
 // -----------------------------------------------------------------------------
 
-/// Retrieves the integer type parameter at \p index, returns a type T.
-/** \p bytes should only be the parameter bytes. */
-
 /**
  * Retrieves the integer type parameter at \p index, returns a type T.
  * @tparam T The type to return.
@@ -759,8 +756,6 @@ auto read_single_token() -> Token
 
 // -----------------------------------------------------------------------------
 
-/// Read a single Event from stdin.
-
 /**
  * Read a single Event from stdin.
  *
@@ -941,7 +936,6 @@ auto read_single_token() -> Token
 
 /**
  * Read an event in alt mode, returns std::nullopt on non-event reads.
- *
  * @details Non-event reads are KeyPress events on stdin, and std::nullopt from
  *          tty.
  * @return The event read from stdin or tty, or std::nullopt if the read was not
@@ -1018,11 +1012,6 @@ auto read_single_token() -> Token
     return std::nullopt;
 }
 
-/// Reads a single token from either STDIN_FILENO or detail::tty_file_descriptor
-/** Assumes the tty_file_descriptor is valid. Returns std::nullopt if nothing
- *  was read in the given timeout time. Can return earlier than timeout with
- *  std::nullopt. */
-
 /**
  * Reads a single token from either STDIN_FILENO or detail::tty_file_descriptor.
  * @details Assumes the tty_file_descriptor is valid. Returns std::nullopt if