prop-doc

KO | EN

gitlite — search

#javascript #hacktoberfest #react #llm #android #machine-learning #deep-learning #linux #nodejs #awesome-list #vue #pytorch #ios #openai

(★ 8)

A properties file parser for parsing javadoc-like annotations out of comment blocks

prop-doc 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

PropDoc
=======

Introduction
------------

PropDoc is a utility that aims to improve the documentability of Java Properties files. It can read in a standard Java Properties file and parse JavaDoc-like annotations out of the comments of properties. Result is a meta-model that can be used to generate documentation about the properties in the file.

Usage
-----

### What you need

1. Maven 2+
2. git

### Checking out the code

<pre>
~$ git clone git://github.com/mrvisser/prop-doc.git
</pre>

### Compiling the jar file

<pre>
~$ cd prop-doc
~/prop-doc$ mvn install
</pre>

### Sample Properties File

**/path/to/file.properties:**

##
	# This is the description of the property. Since it was not preceded with an annotation, it gets dumped into
	# a "description" meta-key that holds all orphaned comments.
	#
	# @values 1-10
	# @default 5
	##
	my.property.key=5

### Using the API

**Java Code:**

InputStream is = null;
	PropDoc propDoc = null;
	try {
		is = new FileInputStream("/path/to/file.properties");
		propDoc = new PropDoc(is);
	} finally {
		if (is != null) {
			is.close();
		}
	}
	
	for (Property prop : propDoc) {
		System.out.printf("Property '%s' has a default of '%s'", prop.getKey(), prop.getMetadataValue("default"));
	}

This program using the properties file example above would output:

Property 'my.property.key' has a default value of '5'

### Using the velocity processor

The Velocity processor allows you to use a velocity template to generate documentation about your properties file. When you run the following maven command in the root of the source tree:

<pre>
~/prop-doc$ mvn assembly:single
</pre>

It should generate you a JAR file in the **target/** directory similar to **prop-doc-1.0-jar-with-dependencies.jar**. This jar is executable, defaulting to the Velocity template propdoc executor:

<pre>
~/prop-doc$ java -jar target/prop-doc-1.0-jar-with-dependencies.jar
Usage: java \
	-Dpropdoc.output.path=&lt;output propdoc file-system path&gt; \
	-Dproperties.file.url=&lt;source properties file URL&gt; (e.g., file://C:\Temp\config.properties; e.g., classpath:org/my/config/config.properties)\
	[-Dvelocity.template.url=&lt;velocity template url&gt; (e.g., file://C:\Temp\propdoc.vm; default: classpath:ca/mrvisser/propdoc/velocity/template.html.vm)]\
	-jar &lt;prop-doc-1.0-jar-with-dependencies&gt;.jar
</pre>

**propdoc.output.path:** The destination for the velocity template output

**properties.file.url:** A URL for the properties file to use as input. This uses the Java standard URL (protocol+path) formatting, with the addition of the classpath: protocol for classpath resources.

**velocity.template.url:** The velocity template to use to generate the output. The velocity template has 2 elements in context:

1. $propDoc - this is the propDoc object generated by parsing the properties file
2. $allAttributes - this is a collection of all meta attributes that were found across all property definitions

The default velocity template generates a simple HTML document: https://github.com/mrvisser/prop-doc/blob/master/src/main/resources/ca/mrvisser/propdoc/velocity/template.html.vm but you are free to write your own.

prop-doc

prop-doc 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

prop-doc

prop-doc 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README