diff options
author | irina-turova <31963497+irina-turova@users.noreply.github.com> | 2023-05-31 16:16:10 +0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-05-31 13:16:10 +0200 |
commit | f45750699d089e0101dcde5d38c7e08ec2f03708 (patch) | |
tree | 13a59ca4458374731e92766f70a1f2183a4ba368 /plugins/javadoc/src/main/resources | |
parent | 0cad056d84bf1dbe285ca008be17ca5fbb224818 (diff) | |
download | dokka-f45750699d089e0101dcde5d38c7e08ec2f03708.tar.gz dokka-f45750699d089e0101dcde5d38c7e08ec2f03708.tar.bz2 dokka-f45750699d089e0101dcde5d38c7e08ec2f03708.zip |
Add support for `@author`, `@since`, `@return` Javadoc tags (#2967)
Diffstat (limited to 'plugins/javadoc/src/main/resources')
-rw-r--r-- | plugins/javadoc/src/main/resources/static_res/stylesheet.css | 10 | ||||
-rw-r--r-- | plugins/javadoc/src/main/resources/views/class.korte | 38 |
2 files changed, 43 insertions, 5 deletions
diff --git a/plugins/javadoc/src/main/resources/static_res/stylesheet.css b/plugins/javadoc/src/main/resources/static_res/stylesheet.css index e46e2825..5d5bc20a 100644 --- a/plugins/javadoc/src/main/resources/static_res/stylesheet.css +++ b/plugins/javadoc/src/main/resources/static_res/stylesheet.css @@ -352,6 +352,12 @@ ul.blockList li.blockList h2 { font-size:14px; font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; } + +.contentContainer .description dl dt p, .contentContainer .details dl dt p, .serializedFormContainer dl dt p, +.contentContainer .description dl dd p, .contentContainer .details dl dd p, .serializedFormContainer dl dd p { + margin:5px 0 10px 0px; +} + .serializedFormContainer dl.nameValue dt { margin-left:1px; font-size:1.1em; @@ -629,8 +635,8 @@ h1.hidden { } .deprecatedLabel, .descfrmTypeLabel, .implementationLabel, .memberNameLabel, .memberNameLink, .moduleLabelInPackage, .moduleLabelInType, .overrideSpecifyLabel, .packageLabelInType, -.packageHierarchyLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel, -.throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink { +.packageHierarchyLabel, .authorLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel, +.throwsLabel, .sinceLabel, .typeNameLabel, .typeNameLink, .searchTagLink { font-weight:bold; } .deprecationComment, .emphasizedPhrase, .interfaceName { diff --git a/plugins/javadoc/src/main/resources/views/class.korte b/plugins/javadoc/src/main/resources/views/class.korte index 84e302fb..54106dda 100644 --- a/plugins/javadoc/src/main/resources/views/class.korte +++ b/plugins/javadoc/src/main/resources/views/class.korte @@ -38,6 +38,24 @@ {% if signature.supertypes != null %}{{signature.supertypes|raw}}{% endif %} </pre> <div class="block">{{ classlikeDocumentation|raw }}</div> + + <dl> + + {% if sinceTagContent.size() != 0 %} + <dt><span class="sinceLabel">Since:</span></dt> + {% for since in sinceTagContent %} + <dd>{{ since|raw }}</dd> + {% endfor %} + {% endif %} + + {% if authorTagContent.size() != 0 %} + <dt><span class="authorLabel">Author:</span></dt> + {% for author in authorTagContent %} + <dd>{{ author|raw }}</dd> + {% endfor %} + {% endif %} + + </dl> </li> </ul> </div> @@ -271,17 +289,31 @@ <h4>{{ method.name }}</h4> <pre class="methodSignature">{{ method.signature.annotations|raw }} {{ method.signature.modifiers|raw }} {{ method.signature.signatureWithoutModifiers|raw}}</pre> <div class="block">{{ method.description|raw }}</div> - {% if method.parameters.size != 0 && hasAnyDescription(method.parameters) %} + <dl> + + {% if method.parameters.size != 0 && hasAnyDescription(method.parameters) %} <dt><span class="paramLabel">Parameters:</span></dt> {% for parameter in method.parameters %} {% if parameter.description != "" %} <dd><code>{{ parameter.name }}</code> - {{ parameter.description|raw }}</dd> {% endif %} {% endfor %} - </dl> {% endif %} - <!-- TODO missing return annotation --> + + {% if method.returnTagContent != "" %} + <dt><span class="returnLabel">Returns:</span></dt> + <dd>{{ method.returnTagContent|raw }}</dd> + {% endif %} + + {% if method.sinceTagContent.size() != 0 %} + <dt><span class="sinceLabel">Since:</span></dt> + {% for since in method.sinceTagContent %} + <dd>{{ since|raw }}</dd> + {% endfor %} + {% endif %} + + </dl> </li> </ul> {% endfor %} |