asf-site-src/source/documentation/in-progress.html.md - yetus - Git at Google

 <!---
   Licensed to the Apache Software Foundation (ASF) under one
   or more contributor license agreements.  See the NOTICE file
   distributed with this work for additional information
   regarding copyright ownership.  The ASF licenses this file
   to you under the Apache License, Version 2.0 (the
   "License"); you may not use this file except in compliance
   with the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing,
   software distributed under the License is distributed on an
   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   KIND, either express or implied.  See the License for the
   specific language governing permissions and limitations
   under the License.
 -->

 # Yetus Precommit

 The [Yetus Precommit build, patch, and CI suite](precommit) allows projects to codify their patch acceptance criteria and then evaluate incoming contributions prior to review by a committer.

 ## Yetus Release Doc Maker

 The Release Documentation Maker allows projects to generate nicely formatted Markdown Changelogs and Release Notes based upon JIRA. You can view that
 [Release Doc Maker documentation](releasedocmaker).

 ## Yetus Shelldocs

 Shelldocs provides generation of html formatted api documentation based on comments on Bash functions. Currently supports documenting API status (public / private) as well as parameters and return values.

 See the [shelldocs page](shelldocs) for more information on usage.

 ## yetus-maven-plugin

 The [yetus-maven-plugin documentation](yetus-maven-plugin/) provides useful utility functions that are missing from Maven.

 ## Javadocs: Yetus Audience Annotations and more

 Audience Annotations allows you to use Java Annotations to denote which parts of your Java library is publicly consumable and which parts are reserved for a more restricted use. It also provides doclets and examples for generating javadocs limited by audience.
 You can refer to the [interface classification documentation](interface-classification).

 All javadocs (including audience annotations) are located in the [Javadocs section](javadocs/).
	<!---
	Licensed to the Apache Software Foundation (ASF) under one
	or more contributor license agreements. See the NOTICE file
	distributed with this work for additional information
	regarding copyright ownership. The ASF licenses this file
	to you under the Apache License, Version 2.0 (the
	"License"); you may not use this file except in compliance
	with the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing,
	software distributed under the License is distributed on an
	"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	KIND, either express or implied. See the License for the
	specific language governing permissions and limitations
	under the License.
	-->

	# Yetus Precommit

	The [Yetus Precommit build, patch, and CI suite](precommit) allows projects to codify their patch acceptance criteria and then evaluate incoming contributions prior to review by a committer.

	## Yetus Release Doc Maker

	The Release Documentation Maker allows projects to generate nicely formatted Markdown Changelogs and Release Notes based upon JIRA. You can view that
	[Release Doc Maker documentation](releasedocmaker).

	## Yetus Shelldocs

	Shelldocs provides generation of html formatted api documentation based on comments on Bash functions. Currently supports documenting API status (public / private) as well as parameters and return values.

	See the [shelldocs page](shelldocs) for more information on usage.

	## yetus-maven-plugin

	The [yetus-maven-plugin documentation](yetus-maven-plugin/) provides useful utility functions that are missing from Maven.

	## Javadocs: Yetus Audience Annotations and more

	Audience Annotations allows you to use Java Annotations to denote which parts of your Java library is publicly consumable and which parts are reserved for a more restricted use. It also provides doclets and examples for generating javadocs limited by audience.
	You can refer to the [interface classification documentation](interface-classification).

	All javadocs (including audience annotations) are located in the [Javadocs section](javadocs/).