Javadown

Parent POM for Samson.PH projects

License

License

GroupId

GroupId

ph.samson
ArtifactId

ArtifactId

javadown
Last Version

Last Version

1.0.1
Release Date

Release Date

Type

Type

jar
Description

Description

Javadown
Parent POM for Samson.PH projects
Project URL

Project URL

https://github.com/esamson/javadown
Project Organization

Project Organization

samson.ph
Source Code Management

Source Code Management

https://github.com/esamson/javadown

Download javadown

How to add to project

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

Dependencies

compile (1)

Group / Artifact Type Version
org.pegdown : pegdown jar 1.4.2

system (1)

Group / Artifact Type Version
com.sun » tools Optional jar ${java.version}

Project Modules

There are no modules declared in this project.

javadown

javadown is a fork of the Javadoc Standard Doclet that allows for javadoc to be written in Markdown syntax. All the standard javadocs tags are supported.

Installation

javadown is released to Maven Central. You may use it directly in your maven projects.

If you're not using maven, you may still download the jar manually from Maven Central. Note that pegdown is used for Markdown processing. You'll need that and all its dependencies, too.

Usage

To use, simply specify ph.samson.javadown.Javadown as the doclet to be used by the javadoc tool. For example, in Maven one would say:

    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.9.1</version>
        <configuration>
            <doclet>ph.samson.javadown.Javadown</doclet>
            <docletArtifact>
                <groupId>ph.samson</groupId>
                <artifactId>javadown</artifactId>
                <version>1.0.1</version>
            </docletArtifact>
        </configuration>
    </plugin>

Versions

Version
1.0.1
1.0
0.2
0.1