Skip to content
  1. Oct 15, 2020
  2. Oct 12, 2020
  3. Oct 08, 2020
  4. Oct 07, 2020
  5. Oct 06, 2020
  6. Oct 02, 2020
    • Chris Kay's avatar
      docs: Fix multiple `\retval` commands errors · 6a57743e
      Chris Kay authored
      
      
      More recent versions of Doxygen now complain when multiple `\retval`
      commands are found with the same return value. This commit fixes these
      issues, replacing them instead with a single `\retval` containing a list
      of possible reasons the function might return the value.
      
      Change-Id: I8d1a09de92ffb0f6c9c662b2c28c999f52dd7d1d
      Signed-off-by: Chris Kay's avatarChris Kay <chris.kay@arm.com>
      6a57743e
    • Chris Kay's avatar
      docs: Fix unbalanced Doxygen groups · fe88326f
      Chris Kay authored
      
      
      This commit fixes a number of places where Doxygen groups commands have
      been mismatched.
      
      Change-Id: If2e18c5e45a9a5d16a5c1f48fdaa975189957400
      Signed-off-by: Chris Kay's avatarChris Kay <chris.kay@arm.com>
      fe88326f
    • Chris Kay's avatar
      docs: Replace `\ref` with `::` · cbbf44b6
      Chris Kay authored
      
      
      The code-base is currently fairly inconsistent with its usage of the
      `::` prefix and the `\ref`. This commit replaces any instances of `\ref`
      with `::`.
      
      Change-Id: I02c1b6e2caf0f333388f44ac51ede060aa0568c3
      Signed-off-by: Chris Kay's avatarChris Kay <chris.kay@arm.com>
      cbbf44b6
    • Chris Kay's avatar
      docs: Normalize Doxygen paragraph indentation · 691839e0
      Chris Kay authored
      
      
      Doxygen continutation line intendation across the code-base is currently
      inconsistent in spite of the code-style documentation specifying a
      two-tab indent on continuation lines.
      
      Change-Id: I0944d749042972797bde1997f02afd98d4028c1a
      Signed-off-by: Chris Kay's avatarChris Kay <chris.kay@arm.com>
      691839e0
    • Chris Kay's avatar
      docs: Prefer `\` to `@` in Doxygen comments · 3361c326
      Chris Kay authored
      
      
      This commit replaces any instances of `@`-style Doxygen commands with
      their `\`-style equivalents. This is done for consistency across the
      codebase.
      
      The `\sa` Doxygen command has been added to the Clang-Format
      configuration to prevent it from reflowing see-also comments, which
      often exceed the column limit due to referring to long URLs.
      
      Change-Id: Ia4ebe8bd310293da9e2af55fe253f0762807e88a
      Signed-off-by: Chris Kay's avatarChris Kay <chris.kay@arm.com>
      3361c326
Loading