Package org.erowid.masterdoc

Masterdoc is designed to create an enterprise Javadoc site, with multiple local Javadoc repositories each cross-linked, along with references to useful external repositories.

See:
Description

Class Summary

ExternalLink	A link that can be exposed by an Internal API.
ExternalRepository	An external API
GeneratorApi	Generates the internal APIs
GeneratorDocBase	Generates the docbase.
GeneratorMain	Given a MasterRepository, this class will generate the documentation by delegating to the other "generator" classes : GeneratorApi, GeneratorDocBase, and GeneratorSearchBase.
GeneratorMasterDocPages	Generates the MasterDoc specific pages.
GeneratorSearchBase	Generates the search data.
InternalRepository	The settings for APIs that are to be generated.
Main	Runner for Masterdoc.
MasterDocConfigurator	Given a config file, returns a MasterRepository.
MasterDocFilter	Masterdoc file filter for indexing, spidering.
MasterRepository	The API to generate.
Repository	A Javadoc API.

Package org.erowid.masterdoc Description

Masterdoc is designed to create an enterprise Javadoc site, with multiple local Javadoc repositories each cross-linked, along with references to useful external repositories. Essentially, this creates a useful central location for any developer in an organization to go for documentation. To that end, any given project can also have a document repository exposed, useful links to project websites included.

Finally, using Simple Spider, a search index is populated so that the APIs, documents in the docbase, and code can be searched. SperoSearch can be used to search over that Searchbase, or a simple servlet app can be used. (The servlet code has not yet wandered into the codebase. Soon.)

Here is an example configuration for Masterdoc, excerpted from the RealNetworks install :

<masterdoc>
	<master>
		<internal-root>/var/www/html/masterdoc/</internal-root>
		<external-root>http://platform.real.com/masterdoc/</external-root>

		<description>
			<name>rnwk</name>
			<long>RealNetworks Document Repository</long>
			<short>RealNetworks Documents</short>
		</description>
		
		<docs generate="true">
			<internal-root>/var/www/html/masterdoc/docs/</internal-root>
			<external-root>http://platform.real.com/masterdoc/docs/</external-root>
		</docs>
		
		<api generate="true">
			<internal-root>/var/www/html/masterdoc/api/</internal-root>
			<external-root>http://platform.real.com/masterdoc/api/</external-root>
		</api>

		<!-- valid search types are "applet" and "servlet" -->
		<search generate="true" type="servlet" include-doc="true" include-api="true">	
			<internal-root>/var/tomcat4/webapps/searchdata/</internal-root>
			<external-root>http://platform.real.com:8080/masterdoc/</external-root>
		</search>
		
		<jars>
			<jar path="cvs_head/base/libraries" />
			<jar path="cvs_head/common/dev-libraries" />
			<jar path="cvs_head/deploy" />
		</jars>
	</master>
	<repositories>
		<external>
			<description>
				<name>j2se</name>
				<long>Java 2 Platform, Standard Edition, v1.4.2</long>
				<short>J2SE</short>
			</description>
			<api-url>http://java.sun.com/j2se/1.4.2/docs/api/</api-url>
			<general-url>http://java.sun.com/j2se/</general-url>
		</external>
		<external>
			<description>
				<name>j2ee</name>
				<long>Java 2 Platform, Enterprise Edition, v1.3</long>
				<short>J2EE</short>
			</description>
			<api-url>http://java.sun.com/j2ee/sdk_1.3/techdocs/api/</api-url>
			<general-url>http://java.sun.com/j2ee/</general-url>
		</external>
		
		<internal>
			<description>
				<name>ebi25</name>
				<long>RealNetworks Application Framework. This API includes both Ebi, Ebi-Component, and Page 
					Manager.</long>
				<short>Ebi 2.5</short>
			</description>
			<general-url> http://ebiwiki.prognet.com/wiki/jsp/Wiki?EbiWiki</general-url>
			<paths>
				<path>/home/masterdoc/cvs_head/common/ebi/javasource/</path>
				<path>/home/masterdoc/cvs_head/common/ebi-component/javasource/</path>
				<path>/home/masterdoc/cvs_head/common/pagemanager/javasource/</path>
			</paths>
			<docs>
				<path>/home/masterdoc/cvs_head/common/ebi/doc/ebi</path>
				<path>/home/masterdoc/cvs_head/common/ebi/doc/eabs</path>
				<path>/home/masterdoc/cvs_head/common/ebi/doc/pagemanager</path>
			</docs>
		</internal>
		<internal>
			<description>
				<name>ebi24</name>
				<long>RealNetworks Application Framework. This API includes both Ebi, Ebi-Component, and Page 
					Manager.</long>
				<short>Ebi 2.4</short>
			</description>
			<general-url> http://ebiwiki.prognet.com/wiki/jsp/Wiki?EbiWiki</general-url>
			<paths>
				<path>/home/masterdoc/cvs_24/common/ebi/javasource/</path>
				<path>/home/masterdoc/cvs_24/common/ebi-component/javasource/</path>
				<path>/home/masterdoc/cvs_24/common/pagemanager/javasource/</path>
			</paths>
			<docs>
				<path>/home/masterdoc/cvs_24/common/ebi/doc/ebi</path>
				<path>/home/masterdoc/cvs_24/common/ebi/doc/eabs</path>
				<path>/home/masterdoc/cvs_24/common/ebi/doc/pagemanager</path>
			</docs>
		</internal>
	</repositories>
</masterdoc>