Javadoc author tags are invalid HTML

[oowekyala]

I see everywhere in the codebase these @author tags surrounded by braces:

lingua-franca/org.lflang/src/org/lflang/TargetProperty.java

Line 58 in efcab96

* @author{Marten Lohstroh <marten@berkeley.edu>}

This is invalid HTML

/home/clem/Documents/LF/lingua-franca/org.lflang/src/org/lflang/TargetProperty.java:58: error: malformed HTML
 * @author{Marten Lohstroh <marten@berkeley.edu>}
                           ^

breaks intellij's Javadoc lexer:

and is rendered improperly:

The proper way to write these author tags is without braces, and escaping the <> characters in the email

@author Marten Lohstroh <marten@berkeley.edu>

(or using javadoc's {@literal ...} taglet, but this is uglier IMO.)

I think we should bulk replace these at some point.

[axmmisaka]

I prefer using {@literal} as it is native (switch to < should be easy, but this looks undoubtedly ugly......)
Alternatively, we just don't let people put email on @author; after all, our emails are available at lots of places.....
Please see https://github.com/lf-lang/lingua-franca/tree/axmmisaka/fix-javadoc-author-email

Plus when I run ./gradlew javadoc I can't seem to find author in generated docs...... interesting

[lhstrh]

@axmmisaka: I saw a recent commit somewhere that addresses this, but no corresponding PR?

[lhstrh]

BTW, we can also leave out the email addresses...

[axmmisaka]

@axmmisaka: I saw a recent commit somewhere that addresses this, but no corresponding PR?

I made a new branch but not PR because I don't know 1. if this is satisfactory and 2. if we want to do this (instead of just removing all emails)

[lhstrh]

Posting the PR is a way to find out :-) You can ask for reviews...

[lhstrh]

I brought this up doing our weekly meeting, and it seemed nobody minded it if we just strip the email addresses.

[axmmisaka]

Since #1486 was merged long ago I think this can be closed.