as i said... it is a bit to much .. javadoc is fine and complete programming rookies will never start to work with jump core methods, and will rather work with the api methods. In every case it will need time to learn and get to know a full software!
Sunburned Surveyor wrote: > Is the JavaDoc on OpenJUMP currently being maintained, or are we > relying on the JavaDoc produced as part of Vivid's JUMP Project? > > If this is the case it might cause us some problems as the two code > bases move apart. > > At any rate, I have started to document some of OpenJUMP's source > code. I am adding source code comments to the class files in the > CursorTools package. I am also producing some HTML and simple PDF > documentation for these same classes. (The PDFs are for those that > still like to read on real paper.) :] > > None of this is "official", nor have I committed the source code files > with the revised comments to the CVS. I'd like to know what the other > developers think. I know most of you will be very fond of JavaDoc, and > this isn't JavaDoc... > > On the other hand, I think this documentation offers help to those new > to Java programming or new to OpenJUMP. I earnestly believe that we > will need well documented code to remain a viable and sucessful open > source project. I realize that writing documentation, including source > code comments, doesn't have the same immediate pay-off as writing the > same amount of actual source code. I think it is important in the long > run, however. I'll try to do my share of the documentation tasks, and > this is where I am going to start. > > As I work with OpenJUMP's source code I will try to make a habbit of > working over the source code comments and creating up-to-date API > documentation. > > The Sunburned Surveyor > > P.S. - I have attached files with an example of an OpenJUMP > source code file that I revised the comments on, as well as the HTML > and PDF API documentation that I will be creating. (The source code > comments should follow the standard described here: > http://surveyoswiki.pbwiki.com/Java%20Programming%20Language)s > > ------------------------------------------------------------------------ > > CursorTool > Identity > > > Fully Qualified Interface Name: > com.vividsolutions.jump.workbench.ui.cursortool > Description: This interface is used to encapsulate or capture the > common behavior of CursorTool classes. CursorTools allow the user to > interact with the layer view panel. (For example, drawing a new > linestring geometry on the layer view panel.) > Package Heirarchy > > com > vividsolutions > workbench <jump%3C/div%3E%0A%09%09%09%09%09%3Cdiv%3E%3Ca%20class=> > ui <com.vividsolutions.jump.workbench.ui.html> > cursortool <com.vividsolutions.jump.workbench.ui.cursortool.html> > Inheritence Tree > > No Inheritence > Children > > AbstractCursorTool <AbstractCursorTool.html> > CompositeTool <CompositeTool.html> > DelegatingTool <Delagating.html> > DummyTool <DummyTool.html> > LeftClickFilter <LeftClickFilter.html> > Methods List > > getCursor <#method_1> > getIcon <#method_2> > activate <#method_3> > deactivate <#method_4> > isRightMouseButtonUsed <#method_5> > isGestureInProgress <#method_6> > cancelGesture <#method_7> > getName <#method_8> > Method Description > > Name: getCursor > Method Type: Normal > Return Type: java.awt.Cursor > Access Type: Public > Description: This method returns a Cursor object for the CursorTool. > Overides: None > Throws: None > Method Description > > Name: getIcon > Method Type: Normal > Return Type: javax.swing.Icon > Access Type: Public > Description: This method returns an Icon object that is used to > decorate the mouse cursor when the CursorTool is active. > Overides: None > Throws: None > Method Description > > Name: activate > Method Type: Normal > Return Type: Void > Access Type: Public > Description: This method activates the CursorTool. Once activated the > user can use the CursorTool to interact with the layer view. > Overides: None > Throws: None > Method Description > > Name: deactivate > Method Type: Normal > Return Type: boolean > Access Type: Public > Description: This method deactivates, or "turns off" the CursorTool. > Overides: None > Throws: None > Method Description > > Name: isGestureInProgress > Method Type: Normal > Return Type: boolean > Access Type: Public > Description: This method returns a boolean value indicating if the > CursorTool is being used to interact with the layer view panel. > Overides: None > Throws: None > Method Description > > Name: isRightMouseButtonUsed > Method Type: Normal > Return Type: Void > Access Type: Public > Description: This method returns a boolean value indicating if the > right mouse button is used as part of the users interaction with the > cursor tool. If it is not, the right mouse button can be used to > display a pop-up menu.. > Overides: None > Throws: None > Method Description > > Name: cancelGesture > Method Type: Normal > Return Type: Void > Access Type: Public > Description: This method cancels the users interaction with the layer > view via the cursor tool. > Overides: None > Throws: None > Method Description > > Name: getName > Method Type: Normal > Return Type: String > Access Type: Public > Description: This method returns a String that provides the name and a > short description of this CursorTool. > Overides: None > Throws: None > Java Interface Information Sheet > >------------------------------------------------------------------------ > >/*Style for the parent containing block.*/ > >.wrap_entire >{ >border: 2px solid black; >margin-left: 5%; >margin-right: 5%; >background-color: #6273a3; >} > >.main_content >{ >border: 2px solid black; >margin-left: 10px; >margin-right: 10px; >margin-top: 10px; >margin-bottom: 10px; >background-color: #dbdfe3; >font-weight: 500; >font-family: Arial, sans-serif; >padding: 5px; >} > >.identity >{ >border: 2px solid black; >margin-left: 10px; >margin-right: 10px; >margin-top: 10px; >margin-bottom: 10px; >background-color: white; >font-weight: 500; >font-family: Arial, sans-serif; >padding: 5px; >} > >.title >{ >border: 2px solid black; >margin-left: 10px; >margin-right: 10px; >margin-top: 10px; >margin-bottom: 10px; >background-color: #b1d9f3; >font-color: #260b7e; >font-weight: 900; >font-family: Arial, sans-serif; >padding: 5px; >text-align: center; >} > >.package_hierarchy >{ >border: 2px solid black; >margin-left: 10px; >margin-right: 10px; >margin-top: 10px; >margin-bottom: 10px; >background-color: white; >font-weight: 500; >font-family: Arial, sans-serif; >padding: 5px; >} > >.inheritence_tree >{ >border: 2px solid black; >margin-left: 10px; >margin-right: 10px; >margin-top: 10px; >margin-bottom: 10px; >background-color: white; >font-weight: 500; >font-family: Arial, sans-serif; >padding: 5px; >} > >.children >{ >border: 2px solid black; >margin-left: 10px; >margin-right: 10px; >margin-top: 10px; >margin-bottom: 10px; >background-color: white; >font-weight: 500; >font-family: Arial, sans-serif; >padding: 5px; >} > >.properties_list >{ >border: 2px solid black; >margin-left: 10px; >margin-right: 10px; >margin-top: 10px; >margin-bottom: 10px; >background-color: white; >font-weight: 500; >font-family: Arial, sans-serif; >padding: 5px; >} > >.methods_list >{ >border: 2px solid black; >margin-left: 10px; >margin-right: 10px; >margin-top: 10px; >margin-bottom: 10px; >background-color: white; >font-weight: 500; >font-family: Arial, sans-serif; >padding: 5px; >} > >.property_description >{ >border: 2px solid black; >margin-left: 10px; >margin-right: 10px; >margin-top: 10px; >margin-bottom: 10px; >background-color: white; >font-weight: 500; >font-family: Arial, sans-serif; >padding: 5px; >} > >.method_description >{ >border: 2px solid black; >margin-left: 10px; >margin-right: 10px; >margin-top: 10px; >margin-bottom: 10px; >background-color: white; >font-weight: 500; >font-family: Arial, sans-serif; >padding: 5px; >} > >.parameter_description >{ >border: 2px solid black; >margin-left: 10px; >margin-right: 10px; >margin-top: 10px; >margin-bottom: 10px; >background-color: #b1d9f3; >font-weight: 500; >font-family: Arial, sans-serif; >padding: 5px; >} > >.footer >{ >border: 2px solid black; >margin-left: 10px; >margin-right: 10px; >margin-top: 10px; >margin-bottom: 10px; >padding: 2px; >background-color: #b8b9b5; >font-weight: 600; >font-family: Arial, sans-serif; >text-align: center; >} > >.italic_text >{ >font-family: Arial, sans-serif; >font-weight: 600; >color: black; >font-style: italic; >} > >.bold_text >{ >font-family: Arial, sans-serif; >font-weight: 800; >color: black; >} > >.highlighted_text >{ >font-family: Arial, sans-serif; >font-weight: 800; >color: #260b7e; >font-style: italic; >} > >/*Anchor Styles*/ >.regular >{ >color: #0a2778; >font-style: bold; >font-weight: 600; >font-family: Arial, sans-serif; >} > >.regular:hover >{ >font-style: bold; >font-weight: 600; >color: #09943a; >font-family: Arial, sans-serif; >} > > >------------------------------------------------------------------------ > >------------------------------------------------------------------------- >Using Tomcat but need to do more? Need to support web services, security? >Get stuff done quickly with pre-integrated technology to make your job easier >Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo >http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642 > >------------------------------------------------------------------------ > >_______________________________________________ >Jump-pilot-devel mailing list >Jump-pilot-devel@lists.sourceforge.net >https://lists.sourceforge.net/lists/listinfo/jump-pilot-devel > > ------------------------------------------------------------------------- Using Tomcat but need to do more? Need to support web services, security? Get stuff done quickly with pre-integrated technology to make your job easier Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642 _______________________________________________ Jump-pilot-devel mailing list Jump-pilot-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/jump-pilot-devel
