RFR: JDK-8298405: Markdown support in the standard doclet

[Jonathan Gibbons]

On Wed, 4 Jan 2023 20:32:54 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

>> A quick simplistic scan of the CommonMark spec reveals no clear winner.
>> 
>> 
>>    2 Markdown and
>>    1 Markdown code
>>    1 Markdown content
>>    1 Markdown counts
>>    1 Markdown document
>>    2 Markdown documents
>>    2 Markdown from
>>    1 Markdown have
>>    5 Markdown implementations
>>    1 Markdown inline
>>    2 Markdown is
>>    1 Markdown meanings
>>    1 Markdown paragraph
>>    1 Markdown practice
>>    1 Markdown program
>>    1 Markdown spec
>>    1 Markdown started
>>    6 Markdown syntax
>>    1 Markdown to
>>    1 Markdown treats
>>    1 Markdown version
>>    1 Markdown will
>>    1 Markdown with
>> 
>> 
>> Of these, `content`, `document` and `program` seem the most applicable.
>> 
>> * `content` has the potential for confusion with the `javadoc` `Content` class ... but we already cope with `Element` and `Tag` by leveraging qualifying adjectives.
>> * `document` seems to imply a file full of content, and not the content of (part of) a doc comment
>> * `program` seems too geeky.
>> 
>> Of the choices, `content` seems most reasonable.
>
> Could it be just _Markdown_ similarly to how it's usually just HTML?

Prefer not.  As a noun, I think Markdown refers to the abstract form. In these cases, we're looking for a noun that describes the concrete form (string, content, etc) with Markdown being an adjective to qualify the form.  That being said, I will examine the use of the phrase on a case-by-case basis.

-------------

PR: https://git.openjdk.org/jdk/pull/11701