documentation - Writing java docs - showing an output example -

i'm asking myself how show example of output in java docs. see here...

/**  * returns app's version-info (e.g.: "app 1.2").  */ public static string getappversioninfo() {     return getappname() + " " + getversionname(); } 

how express 'e.g.' in convenient way?

as far know, javadoc doesn't have special tag example values.

the closest thing describing remember encountering examples of hashing algorithms in messagedigest#getalgorithm(). in case authors say

... name should standard java security name (such "sha", "md5", , on). ...

there javadoc howto, discourages using "e.g.":

avoid latin

use "also known as" instead of "aka", use "that is" or "to specific" instead of "i.e.", use "for example" instead of "e.g.", , use "in other words" or "namely" instead of "viz."

other that, i'm not aware of rules or best practices applicable situation.