<commit_before>#Code to JavaDoc

CodeJavaDoc is a tool to connect Java code to JavaDoc parts. Code is copied into JavaDoc. There is support for command-line, maven and eclipse.</div>

Java file is only updated if the code part is changed, update is controlled by a MD5 checksum.</div>

It's only void methods that can be used.

#Code JavaDoc part
Formate:
========
 	/**
	 * <!-- code start[<method to include>] [<MD5 checksum>]-->;
	 * <!-- code end -->;
	 */


Just add the code start and code end tags and then the
code in the method will be copied between tags.

Note: MD5 checksum can be omitted.

Example:
--------
You have the method...

	package codejavadoc;
	...
	 class ExampleClass {
	  public void exampleMethod() {
	  System.out.println("Run example.");
	  }
	 }

...that you want to copy into your JavaDoc, add:
...

	/**
	 * <!-- code start[codejavadoc.ExampleClass.exampleMethod] -->
	 * <!-- code end -->
	 */
	 public void someMethod() {
	 ...
	..you get:
	/**
	 * <!-- code start[codejavadoc.ExampleClass.exampleMethod] [ADF56579088773675DEFCC]-->
	  System.out.println("Run example.");
	 * <!-- code end -->
	 */

You can update the JavaDoc by adding * or other decorations. This is because the formation of JavaDoc won't get overwritten if method isn't changed.

However keep in mind that it's going to be overwritten every time methods are changed or MD5 checksums are changed.
Command line
============
Usage:
--------

	Usage: CodeJavaDoc [-e &lt;encoding&gt;] src_dir
	
note: if encoding is omitted UTF-8 is used by default

Example
-------

	java -cp codejavadoc.jar CodeJavaDoc -e utf-8 /home/username/src/codejavadoc
	
#Maven


groupId:|com.github.podal.codejavadoc
artifactId:|codejavadoc
version:|1.0.0

Example:
--------
	mvn codejavadoc:codejavadoc
#Eclipse

<a href="eclipse">codejavadoc eclipse</a>
Versions:

CodeJavaDoc version|Eclipse version
codejavadoc-1.0.0-SNAPSHOT|com.github.podal.codejavadoc_1.0.10000.jar</td>
<commit_msg>Update readme.<commit_after>#Code to JavaDoc

CodeJavaDoc is a tool to connect Java code to JavaDoc parts. Code is copied into JavaDoc. There is support for command-line, maven and eclipse.</div>

Java file is only updated if the code part is changed, update is controlled by a MD5 checksum.</div>

It's only void methods that can be used.

#Code JavaDoc part
Formate:
========
 	/**
	 * <!-- code start[<method to include>] [<MD5 checksum>]-->;
	 * <!-- code end -->;
	 */


Just add the code start and code end tags and then the
code in the method will be copied between tags.

Note: MD5 checksum can be omitted.

Example:
--------
You have the method...

	package codejavadoc;
	...
	 class ExampleClass {
	  public void exampleMethod() {
	  System.out.println("Run example.");
	  }
	 }

...that you want to copy into your JavaDoc, add:
...

	/**
	 * <!-- code start[codejavadoc.ExampleClass.exampleMethod] -->
	 * <!-- code end -->
	 */
	 public void someMethod() {
	...

you get:
	
	/**
	 * <!-- code start[codejavadoc.ExampleClass.exampleMethod] [ADF56579088773675DEFCC]-->
	  System.out.println("Run example.");
	 * <!-- code end -->
	 */

You can update the JavaDoc by adding * or other decorations. This is because the formation of JavaDoc won't get overwritten if method isn't changed.

However keep in mind that it's going to be overwritten every time methods are changed or MD5 checksums are changed.
Command line
============
Usage:
--------

	Usage: CodeJavaDoc [-e &lt;encoding&gt;] src_dir
	
note: if encoding is omitted UTF-8 is used by default

Example
-------

	java -cp codejavadoc.jar CodeJavaDoc -e utf-8 /home/username/src/codejavadoc
	
#Maven


groupId:|com.github.podal.codejavadoc
artifactId:|codejavadoc
version:|1.0.0

Example:
--------
	mvn codejavadoc:codejavadoc
#Eclipse

<a href="eclipse">codejavadoc eclipse</a>
Versions:

CodeJavaDoc version|Eclipse version
codejavadoc-1.0.0-SNAPSHOT|com.github.podal.codejavadoc_1.0.10000.jar</td>

{'fraction_non_alphanumeric': 0.13133528265107214, 'fraction_numerical': 0.01608187134502924, 'mean_word_length': 2.7939001848428835, 'pattern_counts': {'":': 0, '<': 29, '<?xml version=': 0, '>': 29, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3966270', 'n_tokens_mistral': 1438, 'n_tokens_neox': 1238, 'n_words': 435}