castor

Documentation cleanup

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: 1.1
  • Component/s: Website
  • Labels:
    None
  • Number of attachments :
    0

Description

Clean up documentation. This involves:

1) Fix javadoc API links in build
2) Make sure all links go somewhere
3) Edit for content and for English

plus possible additional fixes.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Werner Guttmann added a comment -

Edward, part of your patch disabled a <b>Blah</b> annotation by switching to an <![CDATA[ ... ]]> section. I guess this was not on intention .... right ?

Show
Werner Guttmann added a comment - Edward, part of your patch disabled a <b>Blah</b> annotation by switching to an <![CDATA[ ... ]]> section. I guess this was not on intention .... right ?
Hide
Permalink
Edward Kuns added a comment -

Part of which patch? I'm not sure what you're referring to here.

Show
Edward Kuns added a comment - Part of which patch? I'm not sure what you're referring to here.
Hide
Permalink
Werner Guttmann added a comment -

In 1744, I can see that somewhere you are adding a a <![CDATA[ ... ]]> where imho you shouldn't .. .

Show
Werner Guttmann added a comment - In 1744, I can see that somewhere you are adding a a <![CDATA[ ... ]]> where imho you shouldn't .. .
Hide
Permalink
Edward Kuns added a comment -

I am still not sure what you're talking about. If I look at the change set at

http://fisheye.codehaus.org/changelog/castor?cs=6544

I see where I added a CDATA in a code panel, so we don't have to escape the '<' characters. Other than that change, searching the patch and searching the fisheye changeset, I don't see any other CDATA.

I do see however where I incorrectly changed to castor.exolab.org instead of castor.codehaus.org, which is what I intended. Ooops.

Was there, perhaps, already a CDATA somewhere that it didn't belong? If I put something in the wrong place, please give me more information, because I cannot find it in the patch I submitted nor in the SVN change set.

Show
Edward Kuns added a comment - I am still not sure what you're talking about. If I look at the change set at http://fisheye.codehaus.org/changelog/castor?cs=6544 I see where I added a CDATA in a code panel, so we don't have to escape the '<' characters. Other than that change, searching the patch and searching the fisheye changeset, I don't see any other CDATA. I do see however where I incorrectly changed to castor.exolab.org instead of castor.codehaus.org, which is what I intended. Ooops. Was there, perhaps, already a CDATA somewhere that it didn't belong? If I put something in the wrong place, please give me more information, because I cannot find it in the patch I submitted nor in the SVN change set.
Hide
Permalink
Edward Kuns added a comment -

Fixed it. Now I understand what you were referring to. I was thinking in our xdoc language and was looking for an annotation. I didn't read your note literally enough and look for a <b> bold tag! D'oh!

Show
Edward Kuns added a comment - Fixed it. Now I understand what you were referring to. I was thinking in our xdoc language and was looking for an annotation. I didn't read your note literally enough and look for a <b> bold tag! D'oh!
Hide
Permalink
Werner Guttmann added a comment -

Great. I was just about to start diggin' for the code line in question, but now that you've figured things yourself, even better ,,, and less work for me.

Show
Werner Guttmann added a comment - Great. I was just about to start diggin' for the code line in question, but now that you've figured things yourself, even better ,,, and less work for me.
Hide
Permalink
Werner Guttmann added a comment -

Time to close this ?

Show
Werner Guttmann added a comment - Time to close this ?
Hide
Permalink
Edward Kuns added a comment -

Nope, we have more documentation cleanup that can be done. When 1.1 is delivered, we can close this grouping issue.

Show
Edward Kuns added a comment - Nope, we have more documentation cleanup that can be done. When 1.1 is delivered, we can close this grouping issue.
Hide
Permalink
Edward Kuns added a comment -

As soon as we deliver 1.1, we should close this issue and open a new one only if there is still a lot of work to be done for documentation.

Show
Edward Kuns added a comment - As soon as we deliver 1.1, we should close this issue and open a new one only if there is still a lot of work to be done for documentation.
Hide
Permalink
Werner Guttmann added a comment -

Will create a new one for 1.1.1 and sub-sequent releases ....

Show
Werner Guttmann added a comment - Will create a new one for 1.1.1 and sub-sequent releases ....

People

  • Assignee:
    Edward Kuns
    Reporter:
    Edward Kuns
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: