Skip to content

Commit

Permalink
small update to @sampleNoComments desc
Browse files Browse the repository at this point in the history
  • Loading branch information
Jolanrensen committed Jan 17, 2025
1 parent a4b69ec commit 1bcb693
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions KDOC_PREPROCESSING.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,8 +316,7 @@ KDoc.
Just like [korro](https://github.com/devcrocod/korro), if `// SampleStart` or `// SampleEnd` are present in the code,
only the code between these markers will be included in the KDoc.

`@sampleNoComments` is the same as `@sample`, but it will remove all comments from the code before pasting it in the
KDoc.
`@sampleNoComments` is the same as `@sample`, but it will remove all KDocs from the code before pasting it here.

### `@exportAsHtmlStart` and `@exportAsHtmlEnd`: Exporting content as HTML

Expand Down

0 comments on commit 1bcb693

Please sign in to comment.