chore: Remove angle brackets from dartdocs

spydon · spydon · commit eb4aac86cf17 · 2025-06-15T22:10:15.000+02:00
diff --git a/packages/tiled/lib/src/chunk.dart b/packages/tiled/lib/src/chunk.dart
@@ -3,7 +3,7 @@ import 'package:tiled/tiled.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <chunk>
+/// `<chunk>`
 ///
 /// * x: The x coordinate of the chunk in tiles.
 /// * y: The y coordinate of the chunk in tiles.
@@ -26,10 +26,11 @@ class Chunk {
   int width;
   int height;
 
-  /// This is not part of the tiled definitions; this is just a convinient
+  /// This is not part of the tiled definitions; this is just a convenient
   /// wrapper over the [data] field that simplifies two things:
   ///
-  /// * represents the matrix as a matrix (List<List<X>>) instead of a flat list
+  /// * represents the matrix as a matrix (`List<List<X>>`) instead of a flat
+  /// list
   /// * wraps the gid integer into the [Gid] class for easy access of properties
   List<List<Gid>> tileData;
 
diff --git a/packages/tiled/lib/src/common/frame.dart b/packages/tiled/lib/src/common/frame.dart
@@ -3,9 +3,9 @@ import 'package:tiled/src/parser.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <frame>
+/// `<frame>`
 ///
-/// * tileid: The local ID of a tile within the parent <tileset>.
+/// * tileid: The local ID of a tile within the parent `<tileset>`.
 /// * duration: How long (in milliseconds) this frame should be displayed
 ///   before advancing to the next frame.
 class Frame {
diff --git a/packages/tiled/lib/src/common/point.dart b/packages/tiled/lib/src/common/point.dart
@@ -3,7 +3,7 @@ import 'package:tiled/src/parser.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <point>
+/// `<point>`
 /// Used to mark an object as a point.
 /// The existing x and y attributes are used to determine the position of the
 /// point.
diff --git a/packages/tiled/lib/src/common/property.dart b/packages/tiled/lib/src/common/property.dart
@@ -5,7 +5,7 @@ import 'package:xml/xml.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <property>
+/// `<property>`
 /// * name: The name of the property.
 /// * type: The type of the property.
 ///   Can be string (default), int, float, bool, color, file or object
@@ -79,7 +79,7 @@ class Property<T> {
             return attrString;
           } else {
             // In tmx files, multi-line text property values can be stored
-            // inside the <property> node itself instead of in the 'value'
+            // inside the `<property>` node itself instead of in the 'value'
             // attribute
             return xml.element.innerText;
           }
diff --git a/packages/tiled/lib/src/common/tiled_image.dart b/packages/tiled/lib/src/common/tiled_image.dart
@@ -4,7 +4,7 @@ import 'package:tiled/src/parser.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <image>
+/// `<image>`
 ///
 /// * format: Used for embedded images, in combination with a data child
 ///   element.
diff --git a/packages/tiled/lib/src/editor_setting/chunk_size.dart b/packages/tiled/lib/src/editor_setting/chunk_size.dart
@@ -3,7 +3,7 @@ import 'package:tiled/src/parser.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <chunksize>
+/// `<chunksize>`
 ///
 /// * width: The width of chunks used for infinite maps (default to 16).
 /// * height: The width of chunks used for infinite maps (default to 16).
diff --git a/packages/tiled/lib/src/editor_setting/editor_setting.dart b/packages/tiled/lib/src/editor_setting/editor_setting.dart
@@ -3,11 +3,11 @@ import 'package:tiled/tiled.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <editorsettings>
+/// `<editorsettings>`
 /// This element contains various editor-specific settings,
 /// which are generally not relevant when reading a map.
 ///
-/// Can contain: <chunksize>, <export>
+/// Can contain: `<chunksize>`, `<export>`
 class EditorSetting {
   ChunkSize? chunkSize;
   Export? export;
diff --git a/packages/tiled/lib/src/editor_setting/export.dart b/packages/tiled/lib/src/editor_setting/export.dart
@@ -3,7 +3,7 @@ import 'package:tiled/src/parser.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <export>
+/// `<export>`
 ///
 /// * target: The last file this map was exported to.
 /// * format: The short name of the last format this map was exported as.
diff --git a/packages/tiled/lib/src/layer.dart b/packages/tiled/lib/src/layer.dart
@@ -8,8 +8,8 @@ import 'package:xml/xml.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// All <tileset> tags shall occur before the first <layer> tag so that parsers
-/// may rely on having the tilesets before needing to resolve tiles.
+/// All `<tileset>` tags shall occur before the first `<layer>` tag so that
+/// parsers may rely on having the tilesets before needing to resolve tiles.
 ///
 /// * id: Unique ID of the layer. Each layer that added to a map gets a unique
 ///   id. Even if a layer is deleted, no layer ever gets the same ID.
@@ -36,7 +36,7 @@ import 'package:xml/xml.dart';
 /// * parallaxy: Vertical parallax factor for this layer.
 ///   Defaults to 1. (since 1.5)
 ///
-/// Can contain at most one: <properties>, <data>
+/// Can contain at most one: `<properties>`, `<data>`
 abstract class Layer {
   /// Incremental ID - unique across all layers
   int? id;
diff --git a/packages/tiled/lib/src/objects/text.dart b/packages/tiled/lib/src/objects/text.dart
@@ -3,7 +3,7 @@ import 'package:tiled/tiled.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <text>
+/// `<text>`
 ///
 /// * fontfamily: The font family used (defaults to "sans-serif")
 /// * pixelsize: The size of the font in pixels (not using points, because
diff --git a/packages/tiled/lib/src/objects/tiled_object.dart b/packages/tiled/lib/src/objects/tiled_object.dart
@@ -3,7 +3,7 @@ import 'package:tiled/tiled.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <object>
+/// `<object>`
 ///
 /// * id: Unique ID of the object. Each object that is placed on a map gets a
 ///   unique id. Even if an object was deleted, no object gets the same ID.
@@ -41,8 +41,8 @@ import 'package:tiled/tiled.dart';
 /// the specified template, properties saved with the object will have higher
 /// priority, i.e. they will override the template properties.
 ///
-/// Can contain at most one: <properties>, <ellipse> (since 0.9),
-/// <point> (since 1.1), <polygon>, <polyline>, <text> (since 1.0)
+/// Can contain at most one: `<properties>`, `<ellipse>` (since 0.9),
+/// `<point>` (since 1.1), `<polygon>`, `<polyline>, `<text> (since 1.0)
 class TiledObject {
   int id;
   String name;
diff --git a/packages/tiled/lib/src/template.dart b/packages/tiled/lib/src/template.dart
@@ -3,7 +3,7 @@ import 'package:tiled/tiled.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <template>
+/// `<template>`
 ///
 /// The template root element contains the saved map object and a tileset
 /// element that points to an external tileset, if the object is a tile object.
@@ -18,7 +18,7 @@ import 'package:tiled/tiled.dart';
 ///   </template>
 /// ```
 ///
-/// Can contain at most one: <tileset>, <object>
+/// Can contain at most one: `<tileset>`, `<object>`
 class Template {
   Tileset? tileSet;
   TiledObject? object;
diff --git a/packages/tiled/lib/src/tiled_map.dart b/packages/tiled/lib/src/tiled_map.dart
@@ -7,7 +7,7 @@ import 'package:xml/xml.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <map>
+/// `<map>`
 ///
 /// * version: The TMX format version. Was “1.0” so far, and will be incremented
 ///   to match minor Tiled releases.
@@ -55,10 +55,10 @@ import 'package:xml/xml.dart';
 ///
 /// The staggered orientation refers to an isometric map using staggered axes.
 ///
-/// Can contain at most one: <properties>
+/// Can contain at most one: `<properties>
 ///
-/// Can contain any number: <tileset>, <layer>, <objectgroup>, <imagelayer>,
-/// <group> (since 1.0), <editorsettings> (since 1.3)
+/// Can contain any number: `<tileset>, `<layer>, `<objectgroup>, `<imagelayer>,
+/// `<group> (since 1.0), `<editorsettings> (since 1.3)
 class TiledMap {
   TileMapType type;
   String version;
diff --git a/packages/tiled/lib/src/tileset/grid.dart b/packages/tiled/lib/src/tileset/grid.dart
@@ -3,7 +3,7 @@ import 'package:tiled/tiled.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <grid>
+/// `<grid>`
 ///
 /// * orientation: Orientation of the grid for the tiles in this tileset
 ///   (orthogonal or isometric, defaults to orthogonal)
diff --git a/packages/tiled/lib/src/tileset/terrain.dart b/packages/tiled/lib/src/tileset/terrain.dart
@@ -3,12 +3,12 @@ import 'package:tiled/tiled.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <terrain>
+/// `<terrain>`
 ///
 /// * name: The name of the terrain type.
 /// * tile: The local tile-id of the tile that represents the terrain visually.
 ///
-/// Can contain at most one: <properties>
+/// Can contain at most one: `<properties>`
 class Terrain {
   String name;
   int tile;
diff --git a/packages/tiled/lib/src/tileset/tile.dart b/packages/tiled/lib/src/tileset/tile.dart
@@ -5,7 +5,7 @@ import 'package:tiled/tiled.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <tile>
+/// `<tile>`
 ///
 /// * id: The local tile ID within its tileset.
 /// * type: The type of the tile. Refers to an object type and is used by tile
@@ -18,8 +18,8 @@ import 'package:tiled/tiled.dart';
 ///   chosen when it competes with others while editing with the terrain tool.
 ///   (defaults to 0)
 ///
-/// Can contain at most one: <properties>, <image> (since 0.9), <objectgroup>,
-/// <animation>.
+/// Can contain at most one: `<properties>`, `<image>` (since 0.9),
+/// `<objectgroup>`, `<animation>`.
 class Tile {
   int localId;
   String? type;
diff --git a/packages/tiled/lib/src/tileset/tile_offset.dart b/packages/tiled/lib/src/tileset/tile_offset.dart
@@ -3,7 +3,7 @@ import 'package:tiled/src/parser.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <tileoffset>
+/// `<tileoffset>`
 ///
 /// x: Horizontal offset in pixels. (defaults to 0)
 /// y: Vertical offset in pixels (positive is down, defaults to 0)
diff --git a/packages/tiled/lib/src/tileset/tileset.dart b/packages/tiled/lib/src/tileset/tileset.dart
@@ -5,7 +5,7 @@ import 'package:tiled/tiled.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <tileset>
+/// `<tileset>`
 ///
 /// * firstgid: The first global tile ID of this tileset (this global ID maps
 ///   to the first tile in this tileset).
@@ -31,19 +31,19 @@ import 'package:tiled/tiled.dart';
 ///   compatibility reasons. When unspecified, tile objects use bottomleft in
 ///   orthogonal mode and bottom in isometric mode. (since 1.4)
 ///
-/// If there are multiple <tileset> elements, they are in ascending order of
+/// If there are multiple `<tileset>` elements, they are in ascending order of
 /// their firstgid attribute. The first tileset always has a firstgid value of
 /// 1. Since Tiled 0.15, image collection tilesets do not necessarily number
 /// their tiles consecutively since gaps can occur when removing tiles.
 ///
-/// Image collection tilesets have no <image> tag. Instead, each tile has an
-/// <image> tag.
+/// Image collection tilesets have no `<image>` tag. Instead, each tile has an
+/// `<image>` tag.
 ///
-/// Can contain at most one: <image>, <tileoffset>, <grid> (since 1.0),
-/// <properties>, <terraintypes>, <wangsets> (since 1.1), <transformations>
-/// (since 1.5)
+/// Can contain at most one: `<image>`, `<tileoffset>`, `<grid>` (since 1.0),
+/// `<properties>`, `<terraintypes>`, `<wangsets>` (since 1.1),
+/// `<transformations>` (since 1.5)
 ///
-/// Can contain any number: <tile>
+/// Can contain any number: `<tile>`
 class Tileset {
   int? firstGid;
   String? source;
diff --git a/packages/tiled/lib/src/tileset/wang/wang_color.dart b/packages/tiled/lib/src/tileset/wang/wang_color.dart
@@ -3,7 +3,7 @@ import 'package:tiled/tiled.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <wangcolor>
+/// `<wangcolor>`
 /// A color that can be used to define the corner and/or edge of a Wang tile.
 ///
 /// * name: The name of this color.
@@ -12,7 +12,7 @@ import 'package:tiled/tiled.dart';
 /// * probability: The relative probability that this color is chosen over
 ///   others in case of multiple options. (defaults to 0)
 ///
-/// Can contain at most one: <properties>
+/// Can contain at most one: `<properties>`
 class WangColor {
   String name;
   String color;
diff --git a/packages/tiled/lib/src/tileset/wang/wang_set.dart b/packages/tiled/lib/src/tileset/wang/wang_set.dart
@@ -3,18 +3,18 @@ import 'package:tiled/tiled.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <wangset>
+/// `<wangset>`
 ///
 /// Defines a list of corner colors and a list of edge colors, and any number
 /// of Wang tiles using these colors.
 ///
 /// name: The name of the Wang set.
 /// tile: The tile ID of the tile representing this Wang set.
-/// Can contain at most one: <properties>
+/// Can contain at most one: `<properties>`
 ///
-/// Can contain up to 255: <wangcolor> (since Tiled 1.5)
+/// Can contain up to 255: `<wangcolor>` (since Tiled 1.5)
 ///
-/// Can contain any number: <wangtile>
+/// Can contain any number: `<wangtile>`
 class WangSet {
   String name;
   int tile;
diff --git a/packages/tiled/lib/src/tileset/wang/wang_tile.dart b/packages/tiled/lib/src/tileset/wang/wang_tile.dart
@@ -5,7 +5,7 @@ import 'package:tiled/src/parser.dart';
 /// Below is Tiled's documentation about how this structure is represented
 /// on XML files:
 ///
-/// <wangtile>
+/// `<wangtile>`
 ///
 /// Defines a Wang tile, by referring to a tile in the tileset and associating
 /// it with a certain Wang ID.
