doxygen-awesome-css icon indicating copy to clipboard operation
doxygen-awesome-css copied to clipboard

[Feature Request] Changing the style of the `@p` command

Open parmi93 opened this issue 1 year ago • 2 comments

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 avatar Sep 16 '24 13:09 parmi93

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.

jothepro avatar Sep 30 '24 15:09 jothepro

I requested Doxygen (https://github.com/doxygen/doxygen/issues/11240) to add this functionality which was added with v1.13.0, now would it be possible to add a new CSS style for the param class?

parmi93 avatar Jan 06 '25 10:01 parmi93