Formatting and comment improvements

Author: ahoppen

Sources/SwiftSyntax/AbsoluteSyntaxInfo.swift

@@ -30,8 +30,8 @@ struct AbsoluteSyntaxPosition {
   }
 }
 
-/// AbsoluteSyntaxInfo represents the information that relates a RawSyntax to a
-/// source file tree, like its absolute source offset.
+/// `AbsoluteSyntaxInfo` represents the information that relates a `RawSyntax`
+/// to a source file tree, like its absolute source offset.
 struct AbsoluteSyntaxInfo {
   let position: AbsoluteSyntaxPosition
   let nodeId: SyntaxIdentifier

Sources/SwiftSyntax/SyntaxIdentifier.swift

@@ -49,7 +49,7 @@ public struct SyntaxIndexInTree: Comparable, Hashable {
 /// Provides a stable and unique identity for ``Syntax`` nodes.
 ///
 /// Note that two nodes might have the same contents even if their IDs are
-/// different. For example two different ``FunctionDeclSyntax`` nodes in the
+/// different. For example two different ``FunctionDeclSyntax`` nodes
 /// might have the exact same contents but if they occur at a different
 /// location in the source file, they have different IDs.
 ///
@@ -65,6 +65,7 @@ public struct SyntaxIdentifier: Hashable {
   /// exact the same structure. But, two trees with exactly the same structure
   /// might still have different 'rootId's.
   let rootId: UInt
+
   /// Unique value for a node within its own tree.
   @_spi(RawSyntax)
   public let indexInTree: SyntaxIndexInTree

Sources/SwiftSyntax/SyntaxProtocol.swift

@@ -167,7 +167,7 @@ public extension SyntaxProtocol {
 // MARK: Type information
 
 extension SyntaxProtocol {
-  /// The kind of the syntax node, e.g. if it is a `functionDecl`.
+  /// The kind of the syntax node, e.g. if it is a ``SyntaxKind/functionDecl``.
   ///
   /// If you want to check for a node's kind and cast the node to that type, see
   /// `self.as(FunctionDeclSyntax.self)` or `self.as(SyntaxEnum.self)`.
@@ -189,7 +189,7 @@ extension SyntaxProtocol {
 // MARK: Children / parent
 
 public extension SyntaxProtocol {
-  /// A sequence over the `present` children of this node.
+  /// A sequence over the children of this node.
   func children(viewMode: SyntaxTreeViewMode) -> SyntaxChildren {
     return SyntaxChildren(_syntaxNode, viewMode: viewMode)
   }