<snip>: documentation single-sourcing ant task

Download v0.11 JavaDocs Source .zip v0.11 License

February 17, 2004

<snip> is an Ant task designed to help with the single-sourcing of program documentation. This task extracts snippets of text from files, placing them into properties in the Ant project. These properties can then be used by any other Ant task, and are particularly useful when referenced by filters within the <copy> task.

<snip> was originally written to keep snippets of sample code in API documentation synchronized with the actual sample classes.

The <snip> task takes one or more nested filesets that indicate the files to process. Any text between lines containing @@snip:myProperty@@ and @@endSnip@@ will be stored in a property called snip.myProperty.

Example Usage:

<taskdef
  name="snip"
  classname="com.martiansoftware.snip.Snip"
  classpath="snip-0.11.jar"/>
  
<snip>
  <fileset dir="src" includes="**/*.java" />
</snip>

Multiple snippets may be defined within a single file. Snippets may not be nested.

License

Copyright (c) 2004, Martian Software, Inc. All rights reserved.

This license is based upon the OSI-approved BSD License.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of Martin Lamb nor the name of Martian Software, Inc. may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.