Build Phex from Subversion - Revision history

Omega09: spelling

2009-05-10T12:20:25Z

spelling

←Older revision		Revision as of 12:20, 10 May 2009


	=== Structure of src/phex ===		=== Structure of src/phex ===
-	For the most part, you should be able to guess the structure from the folder-names. As general guideline for your own code, check first, if it fits into te already existing structure. Also	+	For the most part, you should be able to guess the structure from the folder-names. As general guideline for your own code, check first, if it fits into the already existing structure. Also

	* All GUI-elements and only those should reside in the folder "gui".		* All GUI-elements and only those should reside in the folder "gui".

	We are always happy to welcome new programmers, novizes as well as experts, long-term coders as well as fly-by code-casters (who write readable code, of course :) ).		We are always happy to welcome new programmers, novizes as well as experts, long-term coders as well as fly-by code-casters (who write readable code, of course :) ).

-	We'd be especially glad to find ~~contributers~~ who take on one of the tasks from our [[Wishlist]], or who contribute further Ideas.	+	We'd be especially glad to find contributors who take on one of the tasks from our [[Wishlist]], or who contribute further Ideas.

	Should you be more interested in beta-testing Phex, please have a look into our [http://www.gnutellaforums.com/forumdisplay.php?forumid=16 forums].		Should you be more interested in beta-testing Phex, please have a look into our [http://www.gnutellaforums.com/forumdisplay.php?forumid=16 forums].

-	Also we search for people, who can help localizing Phex to more languages. We already have German, English, ~~Nederlands~~, French and Spanish.<br/>	+	Also we search for people, who can help localizing Phex to more languages. We already have German, English, Dutch, French and Spanish.<br/>
	If you want to help localizing, please have a look at out [[Localize Phex\|localization-guide]]. We use a simple text-file with entries which can be translated.		If you want to help localizing, please have a look at out [[Localize Phex\|localization-guide]]. We use a simple text-file with entries which can be translated.

Omega09: spelling

2009-05-10T12:17:48Z

spelling

←Older revision		Revision as of 12:17, 10 May 2009

	Maven provides the ability to generate various project documentations.		Maven provides the ability to generate various project documentations.

-	A online version (likely out-of-date) of the Phex Javadoc is also available at: http://www.phex.org/javadoc/phex.	+	An online version (likely out-of-date) of the Phex Javadoc is also available at: http://www.phex.org/javadoc/phex.
-	It includes links to the Phex source code and offers UML ~~diagramms~~ of packages and classes.	+	It includes links to the Phex source code and offers UML diagrams of packages and classes.

	=== Javadoc ===		=== Javadoc ===


	The output is written to $(Phex Folder)/target/site/xref		The output is written to $(Phex Folder)/target/site/xref
-
-

	== Folder Structure ==		== Folder Structure ==

ArneBab: /* Javadoc, typo */

2008-10-13T07:19:06Z

Javadoc, typo

←Older revision		Revision as of 07:19, 13 October 2008

	To draw the UML diagrams the [http://www.graphviz.org/ Graphviz] library is required. Graphviz can be obtained from : http://www.graphviz.org/		To draw the UML diagrams the [http://www.graphviz.org/ Graphviz] library is required. Graphviz can be obtained from : http://www.graphviz.org/

-	After installing Graphviz, you need to add the 'bin' directory to you PATH environment. It should be enough to do this only for the ~~encironment~~ you use to run the Maven process.	+	After installing Graphviz, you need to add the 'bin' directory to you PATH environment. It should be enough to do this only for the environment you use to run the Maven process.

	As output you will get JavaDoc documentation with integrated Phex source and UML diagrams.		As output you will get JavaDoc documentation with integrated Phex source and UML diagrams.

ArneBab: /* Contributing */

2008-10-13T07:06:55Z

Contributing

←Older revision		Revision as of 07:06, 13 October 2008


	Also we search for people, who can help localizing Phex to more languages. We already have German, English, Nederlands, French and Spanish.<br/>		Also we search for people, who can help localizing Phex to more languages. We already have German, English, Nederlands, French and Spanish.<br/>
-	If you want to help localizing, please have a look at out [[Localize Phex\|localization-guide]]. We ~~have~~ a simple text-file with entries, which can be translated.	+	If you want to help localizing, please have a look at out [[Localize Phex\|localization-guide]]. We use a simple text-file with entries which can be translated.

	== See Also ==		== See Also ==

ArneBab: /* Structure of src/phex */

2008-10-13T07:04:37Z

Structure of src/phex

←Older revision		Revision as of 07:04, 13 October 2008


	=== Structure of src/phex ===		=== Structure of src/phex ===
-	For the most part, you should be able to guess the structure from the folder-names.	+	For the most part, you should be able to guess the structure from the folder-names. As general guideline for your own code, check first, if it fits into te already existing structure. Also

	* All GUI-elements and only those should reside in the folder "gui".		* All GUI-elements and only those should reside in the folder "gui".

ArneBab: /* Folder Structure- update */

2008-10-13T06:00:46Z

Folder Structure- update

←Older revision		Revision as of 06:00, 13 October 2008

	Here I'll give a few infos for structuring the code and where to find what.		Here I'll give a few infos for structuring the code and where to find what.

-	All ~~Phex-specific Java-~~code can be found in the folder "src". ~~The~~ code ~~written by the Phex-Team is in the folder~~ src/~~phex~~.	+	All source code can be found in the folder "src". It is split into tests (src/test) and working code (src/main).

-	Libraries are in the folder "thirdparty" and native code for different platforms is in the folder "native". Also as top-level folders you find the installer and docs. The folder ~~"output~~" is where you find the compiled results and the class-files.	+	All Phex-specific Java-code (except the tests) can be found in the folder "src/main/java/". The code written by the Phex-Team is in the folder "src/main/java/phex".
		+
		+	Libraries are in the folder "thirdparty" and native code for different platforms is in the folder "native". Also as top-level folders you find the installer and docs. The folder target" is where you find the compiled results and the class-files.

	=== Structure of src/phex ===		=== Structure of src/phex ===

GregorK: /* Create JavaDoc with UML diagrams */

2008-09-28T13:42:25Z

Create JavaDoc with UML diagrams

←Older revision		Revision as of 13:42, 28 September 2008

	The output is written to $(Phex Folder)/target/site/xref		The output is written to $(Phex Folder)/target/site/xref

-	~~== Create JavaDoc with UML diagrams ==~~

-	~~To create UML diagrams, you need [http://www.spinellis.gr/sw/umlgraph/ UMLGraph] and [http://www.graphviz.org/ Graphviz].~~
-
-	~~Graphviz can be obtained from : http://www.graphviz.org/~~
-	~~To get UMLGraph visit: http://www.spinellis.gr/sw/umlgraph/~~
-
-	~~After installing Graphviz, you need to add the 'bin' directory to you PATH environment. It should be enough to do this only for the script you use to run the ant process.~~
-
-	To integrate UMLGraph, create a copy of <tt>build/build.default.properties</tt> and name it <tt>build/build.user.properties</tt>. Open the <tt>build.user.properties</tt> file in an editor and look for the commented line:<br/>
-	~~<code># doc.uml.UmlGraph.jar =</code>~~
-
-	~~Change the line, remove the comment and let it point to the UmlGraph.jar file on your system:<br/>~~
-	~~<code>doc.uml.UmlGraph.jar = /path/to/UMLGraph/UmlGraph.jar</code>~~
-
-	~~Now you are ready to execute the ant 'uml' task:~~
-	~~cd $(Phex Folder)~~
-	~~cd build~~
-	~~ant uml~~
-
-	~~As output you will get JavaDoc documentation with integrated Phex source and UML diagrams, like they are available at: http://www.phex.org/javadoc/phex.~~
-
-	~~=== Advanced diagrams ===~~
-	~~For advanced usage you can also use the bash (*nix) script to create UML diagrams with the following command (from inside the phex-svn-folder, i.e. trunk):~~
-
-	for i in src/phex/* ; do javadoc -sourcepath ./src/ -docletpath ../javadoc/UmlGraph.jar -doclet gr.spinellis.umlgraph.doclet.UmlGraph -private -horizontal $(find $i -iname \.java) -inferrel -hide "java." -hide "javax." -hide "com." -hide "sun." -hide "org." -qualify -postfixpackage -inferreltype composed -inferdep -inferdepinpackage -useimports ; dot graph.dot -Tsvg > phex-uml-$(basename $i).svg ; done;
-
-	~~It traverses into all directories and creates UML diagrams which are being saved as svg-images in the phex folder (i.e. trunk).~~

	== Folder Structure ==		== Folder Structure ==

GregorK: /* Javadoc */

2008-09-28T13:41:42Z

Javadoc

←Older revision		Revision as of 13:41, 28 September 2008

	=== Javadoc ===		=== Javadoc ===

-	To generate Javadoc API documentation use:	+	To generate Javadoc API documentation including the UML diagrams use:
	mvn javadoc:javadoc		mvn javadoc:javadoc

	The output is written to: $(Phex Folder)/target/site/apidocs		The output is written to: $(Phex Folder)/target/site/apidocs
		+
		+
		+	To draw the UML diagrams the [http://www.graphviz.org/ Graphviz] library is required. Graphviz can be obtained from : http://www.graphviz.org/
		+
		+	After installing Graphviz, you need to add the 'bin' directory to you PATH environment. It should be enough to do this only for the encironment you use to run the Maven process.
		+
		+	As output you will get JavaDoc documentation with integrated Phex source and UML diagrams.

	=== Source cross-reference ===		=== Source cross-reference ===

GregorK: /* Create JavaDoc */

2008-09-27T19:33:31Z

Create JavaDoc

←Older revision		Revision as of 19:33, 27 September 2008

	java -jar target/phex.jar		java -jar target/phex.jar

-	== Create ~~JavaDoc~~ ==	+	== Create Documentation ==

-	~~You can also create~~ the ~~JavaDoc of the Phex code~~ to ~~get a first impression of the structure of Phex~~.	+	Maven provides the ability to generate various project documentations.

-	~~cd $~~(~~Phex Folder~~)	+	A online version (likely out-of-date) of the Phex Javadoc is also available at: http://www.phex.org/javadoc/phex.
		+	It includes links to the Phex source code and offers UML diagramms of packages and classes.
		+
		+	=== Javadoc ===
		+
		+	To generate Javadoc API documentation use:
	mvn javadoc:javadoc		mvn javadoc:javadoc

-	The output ~~will be~~ written to: $(Phex Folder)/target/site/apidocs	+	The output is written to: $(Phex Folder)/target/site/apidocs

-	~~A online version (likely out~~-of-~~date)~~ of ~~the~~ Phex ~~JavaDoc is also available at~~: ~~http~~:~~//www.phex.org/javadoc/phex.~~	+	=== Source cross-reference ===
-	~~It includes links to the Phex source code and offers UML diagramms of packages and classes.~~	+
		+	To generate a source cross-reference of Phex use:
		+	mvn jxr:jxr

-	~~To generate this documentation yourself read the next chapter.~~	+	The output is written to $(Phex Folder)/target/site/xref

	== Create JavaDoc with UML diagrams ==		== Create JavaDoc with UML diagrams ==

GregorK: /* Compiling the Code */

2008-09-27T16:34:15Z

Compiling the Code

←Older revision		Revision as of 16:34, 27 September 2008

	mvn package		mvn package

-	~~This gets us to~~ the ~~next chapter~~.	+	The compiled classes are now available in the directory: $(Phex Folder)/target/classes
		+	The ready to be executed phex.jar file is located at: $(Phex Folder)/target/phex.jar together with its depended libraries.

		+	== Run Phex ==

		+	To run Phex execute from the $(Phex Folder):
		+
		+	java -jar target/phex.jar

	== Create JavaDoc ==		== Create JavaDoc ==