JarCasting
JarCasting JarCasting

Marklet

Fork of Faylixe/marklet in purpose for a great good and more customization

Лицензия

Лицензия
Категории

Категории

Unity Прикладные библиотеки Game Development
Группа

Группа

io.github.atlascommunity
Идентификатор

Идентификатор

marklet
Последняя версия

Последняя версия

1.2.2
Дата

Дата
Тип

Тип

jar
Описание

Описание

Marklet
Fork of Faylixe/marklet in purpose for a great good and more customization
Ссылка на сайт

Ссылка на сайт

https://github.com/atlascommunity/marklet
Система контроля версий

Система контроля версий

https://github.com/atlascommunity/marklet

Скачать marklet

Имя Файла Размер
marklet-1.2.2.pom
marklet-1.2.2.jar 31 KB
marklet-1.2.2-sources.jar 20 KB
marklet-1.2.2-javadoc.jar 482 KB
Обзор

Как подключить последнюю версию

<!-- https://jarcasting.com/artifacts/io.github.atlascommunity/marklet/ -->
<dependency>
    <groupId>io.github.atlascommunity</groupId>
    <artifactId>marklet</artifactId>
    <version>1.2.2</version>
</dependency>
// https://jarcasting.com/artifacts/io.github.atlascommunity/marklet/
implementation 'io.github.atlascommunity:marklet:1.2.2'
// https://jarcasting.com/artifacts/io.github.atlascommunity/marklet/
implementation ("io.github.atlascommunity:marklet:1.2.2")
'io.github.atlascommunity:marklet:jar:1.2.2'
<dependency org="io.github.atlascommunity" name="marklet" rev="1.2.2">
  <artifact name="marklet" type="jar" />
</dependency>
@Grapes(
@Grab(group='io.github.atlascommunity', module='marklet', version='1.2.2')
)
libraryDependencies += "io.github.atlascommunity" % "marklet" % "1.2.2"
[io.github.atlascommunity/marklet "1.2.2"]

Зависимости

compile (2)

Идентификатор библиотеки Тип Версия
org.apache.commons : commons-lang3 jar 3.12.0
net.steppschuh.markdowngenerator : markdowngenerator jar 1.3.1.1

provided (1)

Идентификатор библиотеки Тип Версия
org.projectlombok : lombok jar 1.18.18

test (4)

Идентификатор библиотеки Тип Версия
org.junit.jupiter : junit-jupiter-api jar 5.7.0
org.junit.jupiter : junit-jupiter-engine jar 5.7.0
org.junit.vintage : junit-vintage-engine jar 5.7.0
org.mockito : mockito-core jar 3.8.0

system (1)

Идентификатор библиотеки Тип Версия
com.sun » tools jar ${java.version}

Модули Проекта

Данный проект не имеет модулей.

Marklet

This is custom fork of useful Marklet doclet which main purpose was to generate a Javadoc in a markdown format.

Examples :

In order to use it with Maven, adds the following configuration for the maven-javadoc-plugin in your project POM :

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>${javadoc.plugin.version}</version>
    <configuration>
        <doclet>io.github.atlascommunity.marklet.Marklet</doclet>
        <docletArtifact>
            <groupId>io.github.atlascommunity</groupId>
            <artifactId>marklet</artifactId>
            <version>1.2.1</version>
        </docletArtifact>
        <reportOutputDirectory>./</reportOutputDirectory>
        <destDir>./</destDir>
        <additionalOptions>
            <additionalOption>-d</additionalOption>
            <additionalOption>doc</additionalOption>
            <additionalOption>-e</additionalOption>
            <additionalOption>md</additionalOption>
        </additionalOptions>
        <useStandardDocletOptions>false</useStandardDocletOptions>
    </configuration>
</plugin>

This will generate the javadoc report into the project directory under project subfolder doc.

Java 8 doclint issues.

If you are using Java 8 you may have some issues with doclint validation especially when using markdown blockquotes syntax. To deal with it, just add the following directive to your pom.xml file to deactivate doclint :

<additionalOptions>
    <additionalOption>-Xdoclint:none</additionalOption>
</additionalOptions>

Available doclet options

Option What it does By default
-d set output directory for documentation ./javadoc
-e set files extension .md

Developing Marklet

Marklet requires Apache Maven. In order to build, run

$ mvn install

In order to generate Markdown documentation for Marklet itself, run

$ mvn -P marklet-generation javadoc:javadoc

License

Marklet is licensed under the Apache License, Version 2.0

Current issues

The current version is a still under development with the following feature missing :

  • Interfaces, inner classes, enumerations, and annotations has not been tested already and subject to bug.

  • Migration from com.sun.javadoc to jdk.javadoc.doclet API

  • Version still needs testing

Версии библиотеки

Версия
1.2.2
1.2.1
1.2.0