Accessing User Javadoc In Jcreator, can JCreator access user JavaDoc files? Options

[PhotoMatt]

Just started using JCreator a few weeks ago. Really like it. But, like any good user, I always want more.

The access to API JavaDoc is great. However, I have created JavaDoc for my own classes. Is there a way that I tell JCreator to access it when ctrl-F1 is pressed while selecting one of my own classes?

[Abyzmic]

You should be able to. Just got to your JDK profile, click on edit and under the Documentation tab add in the path to your docs. That should do it. You can do the same with the Sources tab for your source code.

I haven't done this with anything I've personally made, but i did do this for JPVM and it worked great.

[E-E-R]

just verified the above with my own code, and it works great :D

[PhotoMatt]

just verified the above with my own code, and it works great :D
[right][snapback]119[/snapback][/right]

Hmmmm...wonder what I am doing wrong. I put the path in and now I am close, but no cigar.

When I reference one of my objects and press ctrl-F1, the JavaDocs window pops up but not the correct document.

However, under the JavaAPI tag in the popped up window, I do find my documentation, so I know the path is correct and understood by JCreator.

So, I can get to the documentation under JCreator but not seamlessly.

[E-E-R]

Hmmmm...wonder what I am doing wrong.  I put the path in and now I am close, but no cigar.

When I reference one of my objects and press ctrl-F1, the JavaDocs window pops up but not the correct document. 

However, under the JavaAPI tag in the popped up window, I do find my documentation, so I know the path is correct and understood by JCreator.

So, I can get to the documentation under JCreator but not seamlessly.
[right][snapback]127[/snapback][/right]

I fear I may have misunderstood your initial question, after reading it again I saw you mentioned something about Ctrl+F1, which actually did not work too here, I thought you meant the API popup :( (which after more careful review does not work, don't know why)

I have searched for a way to get my api working so I can search it, but unfortunately, I only got it working half... If you generate documentation in for example the directory .\docs, it will not be parsed into the api tree by JC.

I looked at the original Javadocs to see what is so different about them to make them be included into the file path. The first thing that I found out was that sun puts the docs in the directory .\docs\API. I tried this, and instantly my classes were mentioned in the classes tree. :D

unfortunately, JC does not search in those docs, not even when they are the only ones to be found (removed javadocs from profile).

add: I have just spent half an hour to watching the JCreator file activity, and it seems it scans the index-files for a link to the real document... I don't know whether it is possible to generate those with javadoc, but I will look into it.

edit: I have found out that JC really uses the index-files for searching purposes, I have just succesfully broken the api-search by deleting the folder :D
edit2: I have just got it working, yet it has a small, but annoying problem. If you do not have any classes that start with the letter B, and you Ctrl+F1 on a C class, JC will look in the index-3.html, but javadoc generates the numbers not by letter, but by need, so the C will be index-2.html

AFAIK this is not fixable (except renaming every file by hand, which of course is not the idea of this :P).

to generate the index files, use the -splitindex argument when generating javadoc


This post has been edited by E-E-R: Mar 17 2005, 08:21 PM

[PhotoMatt]

You have done a lot of research E-E-R ! thanks. I will just use the non-seamless way to look at my own docs. Hopefully XINOX will look at this and give us a way to include them.

[steven]

Shouldn't JC be able to display Javadoc for a specific project automatically without having to add the documentation path in the *global* documentation library (ie the Java profile)?

If I put my doc files for the project called Project in a subdirectory /javadoc of c:/project then I should be able to add this documentation path to the current project.

Simple as simple can be: just add an additional tab to the project properties window. Or even easier, just as with the current policy regarding src/ and classes/, find out everything, unless the user wants it otherwise...

This would seriously be a good feature. Pity that I am too late to make it into .012 :D