You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by an...@apache.org on 2006/11/14 09:46:17 UTC
svn commit: r474697 -
/lenya/trunk/src/modules-core/linking/java/src/org/apache/lenya/cms/linking/Link.java
Author: andreas
Date: Tue Nov 14 00:46:16 2006
New Revision: 474697
URL: http://svn.apache.org/viewvc?view=rev&rev=474697
Log:
[minor change] added some javadocs
Modified:
lenya/trunk/src/modules-core/linking/java/src/org/apache/lenya/cms/linking/Link.java
Modified: lenya/trunk/src/modules-core/linking/java/src/org/apache/lenya/cms/linking/Link.java
URL: http://svn.apache.org/viewvc/lenya/trunk/src/modules-core/linking/java/src/org/apache/lenya/cms/linking/Link.java?view=diff&rev=474697&r1=474696&r2=474697
==============================================================================
--- lenya/trunk/src/modules-core/linking/java/src/org/apache/lenya/cms/linking/Link.java (original)
+++ lenya/trunk/src/modules-core/linking/java/src/org/apache/lenya/cms/linking/Link.java Tue Nov 14 00:46:16 2006
@@ -28,49 +28,85 @@
private String area;
private String pubId;
+ /**
+ * Ctor.
+ */
public Link() {
}
+ /**
+ * @return The area.
+ */
public String getArea() {
return area;
}
+ /**
+ * @param area The area.
+ */
public void setArea(String area) {
this.area = area;
}
+ /**
+ * @return The language.
+ */
public String getLanguage() {
return language;
}
+ /**
+ * @param language The language.
+ */
public void setLanguage(String language) {
this.language = language;
}
+ /**
+ * @return The publication ID.
+ */
public String getPubId() {
return pubId;
}
+ /**
+ * @param pubId The publication ID.
+ */
public void setPubId(String pubId) {
this.pubId = pubId;
}
+ /**
+ * @return The revision.
+ */
public String getRevision() {
return revision;
}
+ /**
+ * @param revision The revision.
+ */
public void setRevision(String revision) {
this.revision = revision;
}
+ /**
+ * @return The UUID.
+ */
public String getUuid() {
return uuid;
}
+ /**
+ * @param uuid The UUID.
+ */
public void setUuid(String uuid) {
this.uuid = uuid;
}
+ /**
+ * @return The link URI.
+ */
public String getUri() {
String uri = LinkResolver.SCHEME + ":";
if (this.uuid != null) {
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org
Re: not exactly useful javadoc...
Posted by Andreas Hartmann <an...@apache.org>.
Joern Nettingsmeier schrieb:
> andreas@apache.org wrote:
>> Author: andreas
>> Date: Tue Nov 14 00:46:16 2006
>> New Revision: 474697
>>
>> URL: http://svn.apache.org/viewvc?view=rev&rev=474697
>> Log:
>> [minor change] added some javadocs
>
> NOI, but these javadocs are akin to
>
> i++; // increment local counter variable by one
>
> :-D
>
> is there any technical reason to have such non-documentation (except as
> a "write me" reminder)?
No, it's only to avoid the yellow warning signs in Eclipse ...
I should post a feature request that they can be omitted
for getters and setters.
> when i first read those scary looking "Ctor" comments, i spend 10
> minutes googling for the meaning, and then i couldn't believe that
> someone would disguise a perfectly obvious constructor with such a funny
> abbreviation :-D
Mea culpa, that's a bad habit of mine from old C++ times, and you're
not the first one complaining about it. It won't happen anymore
(hopefully).
Thanks for bringing this up,
-- Andreas
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org
not exactly useful javadoc...
Posted by Joern Nettingsmeier <ne...@folkwang-hochschule.de>.
andreas@apache.org wrote:
> Author: andreas
> Date: Tue Nov 14 00:46:16 2006
> New Revision: 474697
>
> URL: http://svn.apache.org/viewvc?view=rev&rev=474697
> Log:
> [minor change] added some javadocs
NOI, but these javadocs are akin to
i++; // increment local counter variable by one
:-D
is there any technical reason to have such non-documentation (except as
a "write me" reminder)?
when i first read those scary looking "Ctor" comments, i spend 10
minutes googling for the meaning, and then i couldn't believe that
someone would disguise a perfectly obvious constructor with such a funny
abbreviation :-D
> Modified:
> lenya/trunk/src/modules-core/linking/java/src/org/apache/lenya/cms/linking/Link.java
>
> Modified: lenya/trunk/src/modules-core/linking/java/src/org/apache/lenya/cms/linking/Link.java
> URL: http://svn.apache.org/viewvc/lenya/trunk/src/modules-core/linking/java/src/org/apache/lenya/cms/linking/Link.java?view=diff&rev=474697&r1=474696&r2=474697
> ==============================================================================
> --- lenya/trunk/src/modules-core/linking/java/src/org/apache/lenya/cms/linking/Link.java (original)
> +++ lenya/trunk/src/modules-core/linking/java/src/org/apache/lenya/cms/linking/Link.java Tue Nov 14 00:46:16 2006
> @@ -28,49 +28,85 @@
> private String area;
> private String pubId;
>
> + /**
> + * Ctor.
> + */
> public Link() {
> }
>
> + /**
> + * @return The area.
> + */
> public String getArea() {
> return area;
> }
>
> + /**
> + * @param area The area.
> + */
> public void setArea(String area) {
> this.area = area;
> }
>
> + /**
> + * @return The language.
> + */
> public String getLanguage() {
> return language;
> }
>
> + /**
> + * @param language The language.
> + */
> public void setLanguage(String language) {
> this.language = language;
> }
>
> + /**
> + * @return The publication ID.
> + */
> public String getPubId() {
> return pubId;
> }
>
> + /**
> + * @param pubId The publication ID.
> + */
> public void setPubId(String pubId) {
> this.pubId = pubId;
> }
>
> + /**
> + * @return The revision.
> + */
> public String getRevision() {
> return revision;
> }
>
> + /**
> + * @param revision The revision.
> + */
> public void setRevision(String revision) {
> this.revision = revision;
> }
>
> + /**
> + * @return The UUID.
> + */
> public String getUuid() {
> return uuid;
> }
>
> + /**
> + * @param uuid The UUID.
> + */
> public void setUuid(String uuid) {
> this.uuid = uuid;
> }
>
> + /**
> + * @return The link URI.
> + */
> public String getUri() {
> String uri = LinkResolver.SCHEME + ":";
> if (this.uuid != null) {
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
> For additional commands, e-mail: commits-help@lenya.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lenya.apache.org
For additional commands, e-mail: dev-help@lenya.apache.org