Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Keep the original code indentation (Origin: bugzilla #793570) #6335

Closed
doxygen opened this issue Jul 2, 2018 · 4 comments
Closed

Keep the original code indentation (Origin: bugzilla #793570) #6335

doxygen opened this issue Jul 2, 2018 · 4 comments
Labels
enhancement a request to enhance doxygen, not a bug HTML HTML / XHTML output

Comments

@doxygen
Copy link
Owner

doxygen commented Jul 2, 2018

status NEW severity normal in component documentation for ---
Reported in version 1.8.15-GIT on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2018-02-18 18:53:50 +0000, silvioprog wrote:

Created attachment 368530
The img1 picture referenced in the issue

Hi.

I have the following documented code:


```c
/**
 * Reads a zero-terminated value from string handle @p str.
 * @param[in] str String handle.
 * @param[out] val Value to be read.
 * @param[in,out] len Pointer to specify then store the value length
including the terminating null byte (<tt>`\0`</tt>).
 * @retval 0 - Success.
 * @retval -EINVAL - Invalid argument.
 * @retval -ENOBUFS - No buffer space available.
 */
extern int bk_str_read(struct bk_str *str, char *val, size_t *len);
```

it generated the attached picture (`img1.png`). But, it should keep the
original indentation, generating something like the second picture
(`img2.png`).

Thank you!

On 2018-02-18 18:54:43 +0000, silvioprog wrote:

Created attachment 368531
The img2 picture referenced in the issue

On 2018-02-18 18:58:31 +0000, silvioprog wrote:

> generating something like the second picture (`img2.png`)

Note the last parenthesis ")" after "size_t * len", the breaking line should
be removed between them.
@albert-github
Copy link
Collaborator

I think it would make sense to move the closing bracket in case of 2 or more arguments to the end of the previous line as compared to now to the next line. In case on 0 or 1 argument this is already the case:

image

image

though not for 2 or more arguments:
image

@doxygen are there any objections against this?

@albert-github albert-github added enhancement a request to enhance doxygen, not a bug HTML HTML / XHTML output labels Nov 20, 2023
@albert-github
Copy link
Collaborator

I've just pushed a proposed patch, pull request #10428

@albert-github albert-github added the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Dec 23, 2023
@albert-github
Copy link
Collaborator

Code has been integrated in master on GitHub (please don't close the issue as this will be done at the moment of an official release).

@doxygen
Copy link
Owner Author

doxygen commented Dec 25, 2023

This issue was previously marked 'fixed but not released',
which means it should be fixed in doxygen version 1.10.0.
Please verify if this is indeed the case. Reopen the
issue if you think it is not fixed and please include any additional information
that you think can be relevant (preferably in the form of a self-contained example).

@doxygen doxygen removed the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Dec 25, 2023
@doxygen doxygen closed this as completed Dec 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement a request to enhance doxygen, not a bug HTML HTML / XHTML output
Projects
None yet
Development

No branches or pull requests

2 participants