On 5/26/20 5:46 AM, Hannes Wallnoefer wrote:
Line 198: "Note: the "Summary" information on a module declaration page would be better 
characterized as "Details" information."
Not sure I understand the rationale behind this sentence. It seems the module 
page is still a summary list that links to details, although the details are on 
separate pages (type and package pages).

The rationale is that "summary sections" generally contain the 1st sentence of a doc comment, which appears elsewhere, in full, in a "details section".

Although we don't have any good examples in the JDK docs, the comments for services (`@provides` and `@uses`) appear in full, and thus should be in a "details" section.  There is no summary of 1st-sentences for services on a module page.

-- Jon

Reply via email to