asciidoclet icon indicating copy to clipboard operation
asciidoclet copied to clipboard

Keep leading spaces in code block

Open AndreVirtimo opened this issue 1 year ago • 3 comments
trafficstars

Hello,

I have followed the guide to disable the creation of <p> for blank line. Now I have the problem that the IntelliJ formatting removes the leading spaces in my code block.

Example

Before:

/**
   * Update a user by providing the data as JSON in the body.
   *
   * .Example body
   * [source,json]
   * ----
   * {
   *      "firstName": "Hans",
   *      "lastName": "Test",
   *      "email": "[email protected]"
   * }
   * ----
   *
   */

After:

/**
   * Update a user by providing the data as JSON in the body.
   *
   * .Example body
   * [source,json]
   * ----
   * {
   * "firstName": "Hans",
   * "lastName": "Test",
   * "email": "[email protected]"
   * }
   * ----
   *
   */

As a workaround I can add

// @formatter:off
// @formatter:on

But I don't want to. Is there any other solution?

AndreVirtimo avatar Oct 30 '24 08:10 AndreVirtimo

I am sorry to say that's an IntelliJ formatting issue and there's nothing we can do from our side. You could try disabling the automatic formatting or customizing the markers to match code blocks delimiters. But I recall IntelliJ expects different markers for start and end (haven't done on some time).

abelsromero avatar Oct 30 '24 11:10 abelsromero

@ahus1 sorry to bring you here, you are familiar with IntellJ internals. Could it be a way to alter formatting of JavaDocs in the intellJ plugin?

abelsromero avatar Oct 30 '24 11:10 abelsromero

I know it is a late reply ... I suggest to disable auto-formatting of JavaDoc altogether when using Asciidoclet.

When using IntelliJ, this can be done via an .editorconfig or via the IDE settings.

# Add to https://editorconfig.org/ - add "root = true" to the root one in your project
[*.java]
ij_java_doc_enable_formatting = true

Or via the IntelliJ settings:

image

I assume this resolves this issue.

ahus1 avatar Dec 22 '24 20:12 ahus1