Skip to content

Commit

Permalink
feat: show symbol types in headings and table of contents (#1178)
Browse files Browse the repository at this point in the history
Closes #1164

### Summary of Changes

Show symbol types in headings and table of contents of the API
reference.

---------

Co-authored-by: megalinter-bot <129584137+megalinter-bot@users.noreply.github.com>
  • Loading branch information
lars-reimann and megalinter-bot authored May 18, 2024
1 parent c9a9373 commit b2f0966
Show file tree
Hide file tree
Showing 185 changed files with 1,032 additions and 845 deletions.
2 changes: 1 addition & 1 deletion .mega-linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
EXTENDS: https://raw.githubusercontent.com/lars-reimann/.github/main/.mega-linter.yml

# Config
FILTER_REGEX_EXCLUDE: (\.github/workflows/|tests/resources/|mkdocs.yml)
FILTER_REGEX_EXCLUDE: (\.github/workflows/|docs/src/overrides/|tests/resources/|mkdocs.yml)

# Workaround to also run prettier on other supported file types. We deactivate it for Markdown compared to the extended
# configuration since it breaks admonitions of Material for MkDocs.
Expand Down
48 changes: 24 additions & 24 deletions docs/api/safeds/data/image/containers/Image.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# :test_tube:{ title="Experimental" } `#!sds abstract class` Image {#safeds.data.image.containers.Image data-toc-label='Image'}
# :test_tube:{ title="Experimental" } <code class="doc-symbol doc-symbol-class"></code> `Image` {#safeds.data.image.containers.Image data-toc-label='[class] Image'}

A container for image data.

Expand Down Expand Up @@ -423,7 +423,7 @@ pipeline example {
}
```

## `#!sds attr` channel {#safeds.data.image.containers.Image.channel data-toc-label='channel'}
## <code class="doc-symbol doc-symbol-attribute"></code> `channel` {#safeds.data.image.containers.Image.channel data-toc-label='[attribute] channel'}

Get the number of channels of the image.

Expand All @@ -437,7 +437,7 @@ pipeline example {
}
```

## `#!sds attr` height {#safeds.data.image.containers.Image.height data-toc-label='height'}
## <code class="doc-symbol doc-symbol-attribute"></code> `height` {#safeds.data.image.containers.Image.height data-toc-label='[attribute] height'}

Get the height of the image in pixels.

Expand All @@ -451,13 +451,13 @@ pipeline example {
}
```

## `#!sds attr` size {#safeds.data.image.containers.Image.size data-toc-label='size'}
## <code class="doc-symbol doc-symbol-attribute"></code> `size` {#safeds.data.image.containers.Image.size data-toc-label='[attribute] size'}

Get the `ImageSize` of the image.

**Type:** [`ImageSize`][safeds.data.image.typing.ImageSize]

## `#!sds attr` width {#safeds.data.image.containers.Image.width data-toc-label='width'}
## <code class="doc-symbol doc-symbol-attribute"></code> `width` {#safeds.data.image.containers.Image.width data-toc-label='[attribute] width'}

Get the width of the image in pixels.

Expand All @@ -471,7 +471,7 @@ pipeline example {
}
```

## `#!sds fun` addNoise {#safeds.data.image.containers.Image.addNoise data-toc-label='addNoise'}
## <code class="doc-symbol doc-symbol-function"></code> `addNoise` {#safeds.data.image.containers.Image.addNoise data-toc-label='[function] addNoise'}

Return a new `Image` with noise added to the image.

Expand Down Expand Up @@ -509,7 +509,7 @@ pipeline example {
}
```

## `#!sds fun` adjustBrightness {#safeds.data.image.containers.Image.adjustBrightness data-toc-label='adjustBrightness'}
## <code class="doc-symbol doc-symbol-function"></code> `adjustBrightness` {#safeds.data.image.containers.Image.adjustBrightness data-toc-label='[function] adjustBrightness'}

Return a new `Image` with an adjusted brightness.

Expand Down Expand Up @@ -547,7 +547,7 @@ pipeline example {
}
```

## `#!sds fun` adjustColorBalance {#safeds.data.image.containers.Image.adjustColorBalance data-toc-label='adjustColorBalance'}
## <code class="doc-symbol doc-symbol-function"></code> `adjustColorBalance` {#safeds.data.image.containers.Image.adjustColorBalance data-toc-label='[function] adjustColorBalance'}

Return a new `Image` with adjusted color balance.

Expand Down Expand Up @@ -585,7 +585,7 @@ pipeline example {
}
```

## `#!sds fun` adjustContrast {#safeds.data.image.containers.Image.adjustContrast data-toc-label='adjustContrast'}
## <code class="doc-symbol doc-symbol-function"></code> `adjustContrast` {#safeds.data.image.containers.Image.adjustContrast data-toc-label='[function] adjustContrast'}

Return a new `Image` with adjusted contrast.

Expand Down Expand Up @@ -623,7 +623,7 @@ pipeline example {
}
```

## `#!sds fun` blur {#safeds.data.image.containers.Image.blur data-toc-label='blur'}
## <code class="doc-symbol doc-symbol-function"></code> `blur` {#safeds.data.image.containers.Image.blur data-toc-label='[function] blur'}

Return a blurred version of the image.

Expand Down Expand Up @@ -660,7 +660,7 @@ pipeline example {
}
```

## `#!sds fun` changeChannel {#safeds.data.image.containers.Image.changeChannel data-toc-label='changeChannel'}
## <code class="doc-symbol doc-symbol-function"></code> `changeChannel` {#safeds.data.image.containers.Image.changeChannel data-toc-label='[function] changeChannel'}

Return a new `Image` that has the given number of channels.

Expand Down Expand Up @@ -688,7 +688,7 @@ The original image is not modified.
) -> result1: Image
```

## `#!sds fun` convertToGrayscale {#safeds.data.image.containers.Image.convertToGrayscale data-toc-label='convertToGrayscale'}
## <code class="doc-symbol doc-symbol-function"></code> `convertToGrayscale` {#safeds.data.image.containers.Image.convertToGrayscale data-toc-label='[function] convertToGrayscale'}

Return a new `Image` that is converted to grayscale.

Expand Down Expand Up @@ -716,7 +716,7 @@ pipeline example {
fun convertToGrayscale() -> result1: Image
```

## `#!sds fun` crop {#safeds.data.image.containers.Image.crop data-toc-label='crop'}
## <code class="doc-symbol doc-symbol-function"></code> `crop` {#safeds.data.image.containers.Image.crop data-toc-label='[function] crop'}

Return a new `Image` that has been cropped to a given bounding rectangle.

Expand Down Expand Up @@ -762,7 +762,7 @@ pipeline example {
}
```

## `#!sds fun` findEdges {#safeds.data.image.containers.Image.findEdges data-toc-label='findEdges'}
## <code class="doc-symbol doc-symbol-function"></code> `findEdges` {#safeds.data.image.containers.Image.findEdges data-toc-label='[function] findEdges'}

Return a grayscale version of the image with the edges highlighted.

Expand Down Expand Up @@ -790,7 +790,7 @@ pipeline example {
fun findEdges() -> result1: Image
```

## `#!sds fun` flipHorizontally {#safeds.data.image.containers.Image.flipHorizontally data-toc-label='flipHorizontally'}
## <code class="doc-symbol doc-symbol-function"></code> `flipHorizontally` {#safeds.data.image.containers.Image.flipHorizontally data-toc-label='[function] flipHorizontally'}

Return a new `Image` that is flipped horizontally (vertical axis, flips left-right and vice versa).

Expand Down Expand Up @@ -818,7 +818,7 @@ pipeline example {
fun flipHorizontally() -> result1: Image
```

## `#!sds fun` flipVertically {#safeds.data.image.containers.Image.flipVertically data-toc-label='flipVertically'}
## <code class="doc-symbol doc-symbol-function"></code> `flipVertically` {#safeds.data.image.containers.Image.flipVertically data-toc-label='[function] flipVertically'}

Return a new `Image` that is flipped vertically (horizontal axis, flips up-down and vice versa).

Expand Down Expand Up @@ -846,7 +846,7 @@ pipeline example {
fun flipVertically() -> result1: Image
```

## `#!sds fun` invertColors {#safeds.data.image.containers.Image.invertColors data-toc-label='invertColors'}
## <code class="doc-symbol doc-symbol-function"></code> `invertColors` {#safeds.data.image.containers.Image.invertColors data-toc-label='[function] invertColors'}

Return a new `Image` with colors inverted.

Expand Down Expand Up @@ -874,7 +874,7 @@ pipeline example {
fun invertColors() -> result1: Image
```

## `#!sds fun` resize {#safeds.data.image.containers.Image.resize data-toc-label='resize'}
## <code class="doc-symbol doc-symbol-function"></code> `resize` {#safeds.data.image.containers.Image.resize data-toc-label='[function] resize'}

Return a new `Image` that has been resized to a given size.

Expand Down Expand Up @@ -914,7 +914,7 @@ pipeline example {
}
```

## `#!sds fun` rotateLeft {#safeds.data.image.containers.Image.rotateLeft data-toc-label='rotateLeft'}
## <code class="doc-symbol doc-symbol-function"></code> `rotateLeft` {#safeds.data.image.containers.Image.rotateLeft data-toc-label='[function] rotateLeft'}

Return a new `Image` that is rotated 90 degrees counter-clockwise.

Expand Down Expand Up @@ -942,7 +942,7 @@ pipeline example {
fun rotateLeft() -> result1: Image
```

## `#!sds fun` rotateRight {#safeds.data.image.containers.Image.rotateRight data-toc-label='rotateRight'}
## <code class="doc-symbol doc-symbol-function"></code> `rotateRight` {#safeds.data.image.containers.Image.rotateRight data-toc-label='[function] rotateRight'}

Return a new `Image` that is rotated 90 degrees clockwise.

Expand Down Expand Up @@ -970,7 +970,7 @@ pipeline example {
fun rotateRight() -> result1: Image
```

## `#!sds fun` sharpen {#safeds.data.image.containers.Image.sharpen data-toc-label='sharpen'}
## <code class="doc-symbol doc-symbol-function"></code> `sharpen` {#safeds.data.image.containers.Image.sharpen data-toc-label='[function] sharpen'}

Return a sharpened version of the image.

Expand Down Expand Up @@ -1007,7 +1007,7 @@ pipeline example {
}
```

## `#!sds fun` toJpegFile {#safeds.data.image.containers.Image.toJpegFile data-toc-label='toJpegFile'}
## <code class="doc-symbol doc-symbol-function"></code> `toJpegFile` {#safeds.data.image.containers.Image.toJpegFile data-toc-label='[function] toJpegFile'}

Save the image as a JPEG file.

Expand Down Expand Up @@ -1035,7 +1035,7 @@ pipeline example {
)
```

## `#!sds fun` toPngFile {#safeds.data.image.containers.Image.toPngFile data-toc-label='toPngFile'}
## <code class="doc-symbol doc-symbol-function"></code> `toPngFile` {#safeds.data.image.containers.Image.toPngFile data-toc-label='[function] toPngFile'}

Save the image as a PNG file.

Expand Down Expand Up @@ -1063,7 +1063,7 @@ pipeline example {
)
```

## `#!sds static fun` fromFile {#safeds.data.image.containers.Image.fromFile data-toc-label='fromFile'}
## <code class="doc-symbol doc-symbol-static-function"></code> `fromFile` {#safeds.data.image.containers.Image.fromFile data-toc-label='[static-function] fromFile'}

Create an image from a file.

Expand Down
Loading

0 comments on commit b2f0966

Please sign in to comment.