[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gzz-commits] manuscripts/UMLLink short-paper.rst
From: |
Tuomas J. Lukka |
Subject: |
[Gzz-commits] manuscripts/UMLLink short-paper.rst |
Date: |
Wed, 21 May 2003 01:59:36 -0400 |
CVSROOT: /cvsroot/gzz
Module name: manuscripts
Changes by: Tuomas J. Lukka <address@hidden> 03/05/21 01:59:36
Modified files:
UMLLink : short-paper.rst
Log message:
text
CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gzz/manuscripts/UMLLink/short-paper.rst.diff?tr1=1.14&tr2=1.15&r1=text&r2=text
Patches:
Index: manuscripts/UMLLink/short-paper.rst
diff -u manuscripts/UMLLink/short-paper.rst:1.14
manuscripts/UMLLink/short-paper.rst:1.15
--- manuscripts/UMLLink/short-paper.rst:1.14 Tue May 20 15:32:59 2003
+++ manuscripts/UMLLink/short-paper.rst Wed May 21 01:59:36 2003
@@ -2,7 +2,7 @@
Bridging Javadoc and design documentation via UML diagram image maps
====================================================================
-.. $Id: short-paper.rst,v 1.14 2003/05/20 19:32:59 tjl Exp $
+.. $Id: short-paper.rst,v 1.15 2003/05/21 05:59:36 tjl Exp $
.. short paper == 2 pages, deadline the end of May
@@ -80,7 +80,7 @@
This can be daunting to a newcomer; consider the javadoc
for the interface ``java.security.PublicKey`` in Sun's
Java2 SDK 1.4.1
-XXXREF.
+REF?.
While the class is easy to find through the package and class lists
when looking for a class to represent cryptographical public keys,
the javadoc is not terribly useful: there is no information
@@ -88,8 +88,11 @@
The only way to find this out is to click on the ``Use`` link
which lists all the occurrences of this class as method
return values or parameters, without much contextual information
-about the importance of the methods.
-However, what would really help would be a link to the design
+about the importance of the methods - the methods for
+creating a ``PublicKey`` are listed alongside the methods
+that return a ``PublicKey`` contained in another object..
+
+Far more helpful would be a link to the design
documentation, even just a diagram of what the intended
uses or lifespans of classes implementing this interface
are and how one creates them.
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Asko Soukka, 2003/05/08
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Asko Soukka, 2003/05/19
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/20
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/20
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/20
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/20
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/20
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/20
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/20
- [Gzz-commits] manuscripts/UMLLink short-paper.rst,
Tuomas J. Lukka <=
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/21
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/21
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/21
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/21
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/21
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Asko Soukka, 2003/05/21
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/21
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Asko Soukka, 2003/05/21
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Tuomas J. Lukka, 2003/05/21
- [Gzz-commits] manuscripts/UMLLink short-paper.rst, Asko Soukka, 2003/05/21