search

eXtensibleCatalog / Metadata-Services-Toolkit

Tools for processing and aggregating metadata
Other
6 stars 3 forks source link

javadocs documentation #893

Open patrickzurek opened 8 years ago

patrickzurek commented 8 years ago

JIRA issue created by: banderson Originally opened: 2010-09-27 05:22 PM

Issue body: (nt)

patrickzurek commented 8 years ago

JIRA Coment by user: jbrand JIRA Timestamp: 2012-04-06 11:36 AM

Comment body:

I'm not sure what this one is. I can only assume its one of two things or both.

1) go through code and make sure all classes and methods are commented per javadoc standards.

2) run javadoc build and create full set of documentation. post documentation somewhere.

This is 'nice to have' unless someone is asking for it.

patrickzurek commented 8 years ago

JIRA Coment by user: rcook JIRA Timestamp: 2012-04-06 11:42 AM

Comment body:

It is both. What we determined we would do was that when you/developers edit a class or method for new stuff or big fixes, enhancements, you would add documentation "as we go" instead of a big project to do it all at once. Is this happening?

patrickzurek commented 8 years ago

JIRA Coment by user: jbrand JIRA Timestamp: 2012-04-06 11:50 AM

Comment body:

Of course. One of the 1st things you learn in Java developer school (*) is to write comments using the correct style.

Joking aside - yes, I try to adhere to this. But I've never run the javadoc build target. There is no point unless you have users using your stuff as a live api. Theoretically we do in the case of users creating services, but in today's day and age of powerful IDE's, you usually don't need to bother trolling through javadocs.