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

[Feature Request] Changing the style of the @p command #162

Open
parmi93 opened this issue Sep 16, 2024 · 1 comment
Open

[Feature Request] Changing the style of the @p command #162

parmi93 opened this issue Sep 16, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@parmi93
Copy link

parmi93 commented Sep 16, 2024

I think that readability could be improved by introducing a different style for parameters (@p) and code (@c) commands.

For example, I made a small style change for the @p command with the following result:

Dark mode:
image

Light mode:
image

Code documentation:
image

I added the following parameter in the ALIASES setting:
p{1}=<code class="param">\1</code>

and custom.css in the HTML_EXTRA_STYLESHEET setting:

code.param {
	font-weight: 600;
	color: var(--primary-dark-color);
}

Basically I'm copying the style of the parameter names in the function header, by doing this I can visually distinguish more easily when I am referring to a parameter or when I am referring to simple code.

What I don't like about my solution is that I have to use the @p{paramName} syntax instead of @p paramName, which makes comments longer and slightly harder to read.

Do you think it would be possible to implement this change directly in doxygen-awesome-css?
Is there a way to continue using the @p paramName syntax?

@parmi93 parmi93 changed the title Changing the style of the @p command [Feature Request] Changing the style of the @p command Sep 23, 2024
@jothepro jothepro added the enhancement New feature or request label Sep 30, 2024
@jothepro
Copy link
Owner

Unfortunately it seems like both @p and @c are just rendering to <code> blocks in HTML. I don't think that there is a way to distinguish them based on a CSS rule.

Please consider opening a PR at doxygen/doxygen for this feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants