BorlandTalk.com Borland discussion newsgroups   Archives   FAQ   Search   Memberlist   Usergroups   Register   Profile   Log in to check your private messages   Log in  JavaDoc packaging          BorlandTalk.com Forum Index -> JBuilder Documentation View previous topic :: View next topic   Author Message Brian Ray Guest Posted: Mon Oct 11, 2004 7:21 pm    Post subject: JavaDoc packaging How do I package JavaDoc output so that when I import my class package in another project, I can highlight a method and press F1 and have the documentation come up? Right now I get: --------------------------------------------------- com.kable.newsstand.core.sessions Interface NSCore public abstract interface NSCore extends javax.ejb.EJBObject --------------------------------------------------- I am expecting the standard JavaDoc output, and this isn't it. Back to top Tor Iver Wilhelmsen [Team Guest Posted: Tue Oct 12, 2004 7:13 am    Post subject: Re: JavaDoc packaging "Brian Ray" <bray (AT) kable (DOT) com> writes: Quote: How do I package JavaDoc output so that when I import my class package in another project, I can highlight a method and press F1 and have the documentation come up? Does the other project have a javadoc node, and a documentation path to build it to? If you add the project itself as a library, it should automatically pick them up, otherwise (using a ordinary library) you need to specify the doc tree's root. Back to top Brian Ray Guest Posted: Tue Oct 12, 2004 2:42 pm    Post subject: Re: JavaDoc packaging OK, I have it working. I have set the document path in my library. This seems counter intuitive though. I would think that if I include project documentation in my jars that the documentation should work automatically when I include the jar in my library. Otherwise there is no sense in including the documentation in the jar file. Is something that should put in an RFE for? "Tor Iver Wilhelmsen [TeamB]" <tor.iver.wilhelmsen (AT) broadpark (DOT) no> wrote in message news:u655gh0ib.fsf (AT) broadpark (DOT) no... Quote: "Brian Ray" <bray (AT) kable (DOT) com> writes: How do I package JavaDoc output so that when I import my class package in another project, I can highlight a method and press F1 and have the documentation come up? Does the other project have a javadoc node, and a documentation path to build it to? If you add the project itself as a library, it should automatically pick them up, otherwise (using a ordinary library) you need to specify the doc tree's root. Back to top Gillmer J. Derge [TeamB] Guest Posted: Tue Oct 12, 2004 3:25 pm    Post subject: Re: JavaDoc packaging Brian Ray wrote: Quote: I would think that if I include project documentation in my jars that the documentation should work automatically when I include the jar in my library. Otherwise there is no sense in including the documentation in the jar file. Is something that should put in an RFE for? If you think it should be done, then enter it in QualityCentral: http://qc.borland.com. My feeling, however, is that it shouldn't and can't be implemented. How is JBuilder supposed to know whether you put the documentation in doc, docs, doc/api, docs/api, doc/javadoc, doc/javadocs, docs/javadoc, docs/javadocs, ... ? I guess you could make a list of all the places you think are "right," but there's always going to be someone who puts them somewhere else and insists that's the "right" place. IMHO JBuilder's solution of letting you specify where they are is perfect. -- Gillmer J. Derge [TeamB] Back to top Brian Ray Guest Posted: Tue Oct 12, 2004 4:06 pm    Post subject: Re: JavaDoc packaging Can't the location be put in the manifest file? If I want to compile some new widget into a .jar so I can give it to people, I have to send them a folder of of the documentation too? Then if I make a new version in six months, they have to delete their old document folder, and create a new one (or put the doc in a different place and change their library definitions)? "Gillmer J. Derge [TeamB]" <spam (AT) gillmerderge (DOT) com> wrote Quote: Brian Ray wrote: I would think that if I include project documentation in my jars that the documentation should work automatically when I include the jar in my library. Otherwise there is no sense in including the documentation in the jar file. Is something that should put in an RFE for? If you think it should be done, then enter it in QualityCentral: http://qc.borland.com. My feeling, however, is that it shouldn't and can't be implemented. How is JBuilder supposed to know whether you put the documentation in doc, docs, doc/api, docs/api, doc/javadoc, doc/javadocs, docs/javadoc, docs/javadocs, ... ? I guess you could make a list of all the places you think are "right," but there's always going to be someone who puts them somewhere else and insists that's the "right" place. IMHO JBuilder's solution of letting you specify where they are is perfect. -- Gillmer J. Derge [TeamB] Back to top Gillmer J. Derge [TeamB] Guest Posted: Tue Oct 12, 2004 4:12 pm    Post subject: Re: JavaDoc packaging Brian Ray wrote: Quote: Can't the location be put in the manifest file? If I want to compile some new widget into a .jar so I can give it to people, I have to send them a folder of of the documentation too? Then if I make a new version in six months, they have to delete their old document folder, and create a new one (or put the doc in a different place and change their library definitions)? You can use the same JAR file for both the classes and the documentation. You just need to configure the JBuilder library so it knows where they are. But they don't need to be in different files. -- Gillmer J. Derge [TeamB] Back to top Brian Ray Guest Posted: Tue Oct 12, 2004 4:21 pm    Post subject: Re: JavaDoc packaging If I go to the configure libraries page, and select my library, then go to the document tab and put in a jar file, the documentation doesn't work. If I put in the location of the documentation, instead of the .jar file, it works. How do I configure the library so that it looks at the documentation... Idea! ...working... I figured it out! You have to tell it where in tha jar file it is! Thanks for your help. "Gillmer J. Derge [TeamB]" <spam (AT) gillmerderge (DOT) com> wrote Quote: Brian Ray wrote: Can't the location be put in the manifest file? If I want to compile some new widget into a .jar so I can give it to people, I have to send them a folder of of the documentation too? Then if I make a new version in six months, they have to delete their old document folder, and create a new one (or put the doc in a different place and change their library definitions)? You can use the same JAR file for both the classes and the documentation. You just need to configure the JBuilder library so it knows where they are. But they don't need to be in different files. -- Gillmer J. Derge [TeamB] Back to top Display posts from previous: All Posts1 Day7 Days2 Weeks1 Month3 Months6 Months1 Year Oldest FirstNewest First         BorlandTalk.com Forum Index -> JBuilder Documentation All times are GMT Page 1 of 1   Jump to: Select a forum C++ Builder Newsgroups----------------C++ BuilderC++ Builder (ActiveX)C++ Builder (Announcements)C++ Builder (Command Line Tools)C++ Builder DatabasesC++ Builder Databases (ADO)C++ Builder Databases (Desktop)C++ Builder Databases (InterBase Express)C++ Builder Databases (Multi-Tier)C++ Builder Databases (SQL Servers)C++ Builder (Graphics)C++ Builder (IDE)C++ Builder (Internet)C++ Builder (Internet Socket)C++ Builder (Internet Web)C++ Builder (Jobs)C++ Builder (Language)C++ Builder (Language C++)C++ Builder (Compatibility with MFC)C++ Builder (Native API)C++ Builder (Non-Technical)C++ Builder (Students)C++ Builder (Third Party Tools)C++ Builder (Upgrade)C++ Builder (VCL)C++ Builder (VCL Components Usage)C++ Builder (VCL Components Development)C++ Builder (VCL Usage)C++ Builder (WinAPI)C++ Builder Installation Delphi Newsgroups----------------Delphi (General)Delphi ActiveX Controls UsageDelphi ActiveX Controls DevelopmentDelphi As400Delphi DatabasesDelphi Databases (ADO)Delphi Databases (dbExpress)Delphi Databases (Desktop)Delphi Databases (InterBase Express)Delphi Databases (Multi-Tier)Delphi Databases (SQL Servers)Delphi DeploymentDelphi GraphicsDelphi IDEDelphi InternationalizationDelphi InternetDelphi Internet Isapi-WebBrokerDelphi Internet WebSnapDelphi Internet WinsockDelphi JobsDelphi Language BASMDelphi Language ObjectPascalDelphi Model Driven Architecture (General)Delphi Model Driven Architecture (Third Party)Delphi MultimediaDelphi Native APIDelphi Non-TechnicalDelphi ObjectPascalDelphi OLE AutomationDelphi OO designDelphi OpenToolsAPIDelphi Reporting-ChartingDelphi RTLDelphi StudentsDelphi TeamSourceDelphi Thirdparty ToolsDelphi Thirdparty Tools (General)Delphi Thirdparty Tools (IntraWeb)Delphi Thirdparty Tools (RaveReports)Delphi UpgradeDelphi VCLDelphi VCL ComponentsDelphi VCL Components UsingDelphi VCL Components WritingDelphi WebServices SOAPDelphi WinAPIDelphi XMLDelphi Installationcomp.lang.pascal.delphi.components.misccomp.lang.pascal.delphi.components.usagecomp.lang.pascal.delphi.components.writingcomp.lang.pascal.delphi.databasescomp.lang.pascal.delphi.misccomp.sources.delphi JBuilder Newsgroups----------------JBuilderJBuilder AnnouncementsJBuilder Applet IssuesJBuilder As400JBuilder CompilerJBuilder CORBA/RMIJBuilder DatabasesJBuilder DB SwingJBuilder DebuggerJBuilder DeploymentJBuilder DocumentationJBuilder EnterpriseJBuilder HandheldJBuilder IDEJBuilder JavaJBuilder JavaAPIJBuilder Java LanguageJBuilder Java SwingJBuilder Java BeansJBuilder Java Beans UsageJBuilder Java Beans DevelopmentJBuilder JBCLJBuilder JDataStoreJBuilder JobsJBuilder LinuxJBuilder MacintoshJBuilder & MobileSetJBuilder MultiLingual AppsJBuilder Non-TechnicalJBuilder OpenToolsJBuilder Servlets (JSP)JBuilder StudentsJBuilder Team DevelopmentJBuilder Thirdparty ToolsJBuilder UpgradeJBuilder Installation InterBase Newsgroups----------------InterBaseInterBase Bug DiscussionInterBase GeneralInterBase IBConsoleInterBase OpenSourceInterBase ReplicationInterBase SQLInterBase ThirdpartyInterBase Installation Miscellaneous Borland Newsgroups----------------AppCenterAppServerEnteraVisiBroker  You cannot post new topics in this forum You cannot reply to topics in this forum You cannot edit your posts in this forum You cannot delete your posts in this forum You cannot vote in polls in this forum Powered by phpBB © 2001, 2006 phpBB Group SEO toolkit © 2004-2006 webmedic.