search

Abnaxos / markdown-doclet

A Doclet that allows the use of Markdown in JavaDoc comments.
GNU General Public License v3.0
319 stars 40 forks source link

May I ask how to run gradle task? #81

Closed cjahv closed 7 years ago

cjahv commented 7 years ago

I added it: image

But did not find a new task

gradle tasks           
:tasks

------------------------------------------------------------
All tasks runnable from root project 
------------------------------------------------------------

Application tasks
-----------------
bootRun - Run the project with support for auto-detecting main class and reloading static resources
run - Runs this project as a JVM application

Build tasks
-----------
assemble - Assembles the outputs of this project.
bootRepackage - Repackage existing JAR and WAR archives so that they can be executed from the command line using 'java -jar'
build - Assembles and tests this project.
buildDependents - Assembles and tests this project and all projects that depend on it.
buildNeeded - Assembles and tests this project and all projects it depends on.
classes - Assembles main classes.
clean - Deletes the build directory.
jar - Assembles a jar archive containing the main classes.
testClasses - Assembles test classes.

Build Setup tasks
-----------------
init - Initializes a new Gradle build.
wrapper - Generates Gradle wrapper files.

Distribution tasks
------------------
assembleDist - Assembles the main distributions
distTar - Bundles the project as a distribution.
distZip - Bundles the project as a distribution.
installDist - Installs the project as a distribution as-is.

Documentation tasks
-------------------
javadoc - Generates Javadoc API documentation for the main source code.

Help tasks
----------
buildEnvironment - Displays all buildscript dependencies declared in root project 'oak-auth'.
components - Displays the components produced by root project 'oak-auth'. [incubating]
dependencies - Displays all dependencies declared in root project 'oak-auth'.
dependencyInsight - Displays the insight into a specific dependency in root project 'oak-auth'.
dependentComponents - Displays the dependent components of components in root project 'oak-auth'. [incubating]
help - Displays a help message.
model - Displays the configuration model of root project 'oak-auth'. [incubating]
projects - Displays the sub-projects of root project 'oak-auth'.
properties - Displays the properties of root project 'oak-auth'.
tasks - Displays the tasks runnable from root project 'oak-auth'.

IDE tasks
---------
cleanEclipse - Cleans all Eclipse files.
cleanIdea - Cleans IDEA project files (IML, IPR)
eclipse - Generates all Eclipse files.
idea - Generates IDEA project files (IML, IPR, IWS)

Upload tasks
------------
uploadArchives - Uploads all artifacts belonging to configuration ':archives'

Verification tasks
------------------
check - Runs all checks.
test - Runs the unit tests.

Rules
-----
Pattern: clean<TaskName>: Cleans the output files of a task.
Pattern: build<ConfigurationName>: Assembles the artifacts of a configuration.
Pattern: upload<ConfigurationName>: Assembles and uploads the artifacts belonging to a configuration.

To see all tasks and more detail, run gradle tasks --all

To see more detail about a task, run gradle help --task <task>

BUILD SUCCESSFUL

Total time: 0.757 secs

How should i use it?

Abnaxos commented 7 years ago

The plugin doesn't create a new task. It just changes all existing JavaDoc tasks to use the markdown doclet.