Literal text should be highlighted

frankframework / frank-doc

Frank!Doc

https://frankdoc.frankframework.org

Apache License 2.0

4 stars 5 forks source link

Literal text should be highlighted #195

Open mhdirkse opened 1 week ago

mhdirkse commented 1 week ago

In the picture below, you see two dots. The first dot belongs to a literal text that is cited. The second dot is the end of the sentence. This distinction should appear more clearly.

philipsens commented 1 week ago

The use of "`" around the prefix would be best, I think. It would show like this: In addition to regular parameters for filesystem senders, it is possible to set custom user-metadata on S3 files by prefixing parameter names with FileAttribute..

evandongen commented 1 week ago

In IntelliJ, you can get a preview of your javadoc, see the following screenshot:

Perhaps it is possible to display the text in a similar way in the frank doc?

tnleeuw commented 1 week ago

I don't know if there's something that can be changed in the styling of the included "value" annotation / texts so that they stand out clearly, with a something different background colour and a border-box, similar to how backtick-text is displayed?

nielsm5 commented 1 week ago

Yea, the tiny problem that we have is that we need to do the substitution during the doclet generation, because:

We may not have the required class
We do not store static fields

So the backend needs to substitute the value with html, which is not a problem, but which element... We don't want to interfere with html written in the javadoc it self. A <code> tag could be used?