Javadoc comments in module-info
The Java 9 modules feature adds (higher-level) module-info files in addition to the package-info files that existed previously. Can module-info.java (source-code) files include marked-up comments that the JavaDoc tool will extract and present (usefully) as module-level documentation?
java javadoc java-module module-info
edited Dec 28 '18 at 13:43
nullpointer
44.5k1095184
asked Dec 28 '18 at 11:02
RaedwaldRaedwald
26k2295156
add a comment |
The Java 9 modules feature adds (higher-level) module-info files in addition to the package-info files that existed previously. Can module-info.java (source-code) files include marked-up comments that the JavaDoc tool will extract and present (usefully) as module-level documentation?
java javadoc java-module module-info
edited Dec 28 '18 at 13:43
nullpointer
44.5k1095184
asked Dec 28 '18 at 11:02
RaedwaldRaedwald
26k2295156
add a comment |
The Java 9 modules feature adds (higher-level) module-info files in addition to the package-info files that existed previously. Can module-info.java (source-code) files include marked-up comments that the JavaDoc tool will extract and present (usefully) as module-level documentation?
java javadoc java-module module-info
edited Dec 28 '18 at 13:43
nullpointer
44.5k1095184
asked Dec 28 '18 at 11:02
RaedwaldRaedwald
26k2295156
The Java 9 modules feature adds (higher-level) module-info files in addition to the package-info files that existed previously. Can module-info.java (source-code) files include marked-up comments that the JavaDoc tool will extract and present (usefully) as module-level documentation?
java javadoc java-module module-info
java javadoc java-module module-info
edited Dec 28 '18 at 13:43
nullpointer
44.5k1095184
asked Dec 28 '18 at 11:02
RaedwaldRaedwald
26k2295156
edited Dec 28 '18 at 13:43
nullpointer
44.5k1095184
asked Dec 28 '18 at 11:02
RaedwaldRaedwald
26k2295156
edited Dec 28 '18 at 13:43
nullpointer
44.5k1095184
edited Dec 28 '18 at 13:43
nullpointer
44.5k1095184
edited Dec 28 '18 at 13:43
nullpointer
44.5k1095184
44.5k1095184
asked Dec 28 '18 at 11:02
RaedwaldRaedwald
26k2295156
asked Dec 28 '18 at 11:02
RaedwaldRaedwald
26k2295156
asked Dec 28 '18 at 11:02
RaedwaldRaedwald
26k2295156
26k2295156
add a comment |
add a comment |
2 Answers
2
active
oldest
votes
In a word - yes. You can see, for example, how Java 9's Javadoc has module-level documentation, which then lists the packages in them with their documentation. The packages, in turn, contain classes with their documentation.
As a quick example, check out the jdk.shell module documentation.
answered Dec 28 '18 at 11:09
MureinikMureinik
180k22130199
add a comment |
Yes. And the tags supported at module declaration are:
Module Declaration
{@author}, {@deprecated}, {@provides}, {@see}, {@since}, {@serialField}, {@uses}, {@version}
{@code}, {@docRoot}, {@index}, {@link}, {@linkplain}, {@literal}, {@summary}
Source:- Documentation Comment Specification for the Standard doclet
Amongst these, the newly introduced tags you might further be interested in are :
@index@summary
and then module specific
@provides@uses
edited Dec 29 '18 at 18:14
Raedwald
26k2295156
answered Dec 28 '18 at 13:42
nullpointernullpointer
44.5k1095184
add a comment |
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53957486%2fjavadoc-comments-in-module-info%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
2 Answers
2
active
oldest
votes
2 Answers
2
active
oldest
votes
active
oldest
votes
active
oldest
votes
In a word - yes. You can see, for example, how Java 9's Javadoc has module-level documentation, which then lists the packages in them with their documentation. The packages, in turn, contain classes with their documentation.
As a quick example, check out the jdk.shell module documentation.
answered Dec 28 '18 at 11:09
MureinikMureinik
180k22130199
add a comment |
In a word - yes. You can see, for example, how Java 9's Javadoc has module-level documentation, which then lists the packages in them with their documentation. The packages, in turn, contain classes with their documentation.
As a quick example, check out the jdk.shell module documentation.
answered Dec 28 '18 at 11:09
MureinikMureinik
180k22130199
add a comment |
In a word - yes. You can see, for example, how Java 9's Javadoc has module-level documentation, which then lists the packages in them with their documentation. The packages, in turn, contain classes with their documentation.
As a quick example, check out the jdk.shell module documentation.
answered Dec 28 '18 at 11:09
MureinikMureinik
180k22130199
In a word - yes. You can see, for example, how Java 9's Javadoc has module-level documentation, which then lists the packages in them with their documentation. The packages, in turn, contain classes with their documentation.
As a quick example, check out the jdk.shell module documentation.
answered Dec 28 '18 at 11:09
MureinikMureinik
180k22130199
answered Dec 28 '18 at 11:09
MureinikMureinik
180k22130199
answered Dec 28 '18 at 11:09
MureinikMureinik
180k22130199
answered Dec 28 '18 at 11:09
MureinikMureinik
180k22130199
180k22130199
add a comment |
add a comment |
Yes. And the tags supported at module declaration are:
Module Declaration
{@author}, {@deprecated}, {@provides}, {@see}, {@since}, {@serialField}, {@uses}, {@version}
{@code}, {@docRoot}, {@index}, {@link}, {@linkplain}, {@literal}, {@summary}
Source:- Documentation Comment Specification for the Standard doclet
Amongst these, the newly introduced tags you might further be interested in are :
@index@summary
and then module specific
@provides@uses
edited Dec 29 '18 at 18:14
Raedwald
26k2295156
answered Dec 28 '18 at 13:42
nullpointernullpointer
44.5k1095184
add a comment |
Yes. And the tags supported at module declaration are:
Module Declaration
{@author}, {@deprecated}, {@provides}, {@see}, {@since}, {@serialField}, {@uses}, {@version}
{@code}, {@docRoot}, {@index}, {@link}, {@linkplain}, {@literal}, {@summary}
Source:- Documentation Comment Specification for the Standard doclet
Amongst these, the newly introduced tags you might further be interested in are :
@index@summary
and then module specific
@provides@uses
edited Dec 29 '18 at 18:14
Raedwald
26k2295156
answered Dec 28 '18 at 13:42
nullpointernullpointer
44.5k1095184
add a comment |
Yes. And the tags supported at module declaration are:
Module Declaration
{@author}, {@deprecated}, {@provides}, {@see}, {@since}, {@serialField}, {@uses}, {@version}
{@code}, {@docRoot}, {@index}, {@link}, {@linkplain}, {@literal}, {@summary}
Source:- Documentation Comment Specification for the Standard doclet
Amongst these, the newly introduced tags you might further be interested in are :
@index@summary
and then module specific
@provides@uses
edited Dec 29 '18 at 18:14
Raedwald
26k2295156
answered Dec 28 '18 at 13:42
nullpointernullpointer
44.5k1095184
Yes. And the tags supported at module declaration are:
Module Declaration
{@author}, {@deprecated}, {@provides}, {@see}, {@since}, {@serialField}, {@uses}, {@version}
{@code}, {@docRoot}, {@index}, {@link}, {@linkplain}, {@literal}, {@summary}
Source:- Documentation Comment Specification for the Standard doclet
Amongst these, the newly introduced tags you might further be interested in are :
@index@summary
and then module specific
@provides@uses
edited Dec 29 '18 at 18:14
Raedwald
26k2295156
answered Dec 28 '18 at 13:42
nullpointernullpointer
44.5k1095184
edited Dec 29 '18 at 18:14
Raedwald
26k2295156
edited Dec 29 '18 at 18:14
Raedwald
26k2295156
edited Dec 29 '18 at 18:14
Raedwald
26k2295156
26k2295156
answered Dec 28 '18 at 13:42
nullpointernullpointer
44.5k1095184
answered Dec 28 '18 at 13:42
nullpointernullpointer
44.5k1095184
answered Dec 28 '18 at 13:42
nullpointernullpointer
44.5k1095184
44.5k1095184
add a comment |
add a comment |
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53957486%2fjavadoc-comments-in-module-info%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
