Project

General

Profile

Bug #2273

documentation errors - return types

Added by Rob Nahf almost 13 years ago. Updated almost 13 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Documentation
Start date:
2012-01-31
Due date:
% Done:

100%

Milestone:
CCI-1.0.0
Product Version:
*
Story Points:
Sprint:

Subtasks

Task #2276: update MethodCrossReference.xls in docsClosed

Associated revisions

Revision 6759
Added by Dave Vieglais almost 13 years ago

Corrected signature MNReplication.getReplica; Switched CNIdentity.listSubject and getSubjectInfo to return SubjectInfo structures. Closes #2273

History

#1 Updated by Rob Nahf almost 13 years ago

  • Priority changed from Normal to Urgent
  • Category set to Documentation
  • Assignee set to Dave Vieglais

found a few inconsistencies between java implementation and document after adding an architecture test to compare return types:

CNCore.ping() is documented to return null, but should be a date, as described in the method description (description also refers to MN implementation)
CNIdentity.getSubjectInfo() is documented to return a SubjectList, should be a SubjectInfo object. java implementation is correct (returns SubjectInfo)
MNReplication.getReplica() is documented to return null, should be an InputSteam (OctetStream)

need to resolve these before releasing libclient_java and common_java, in case the documentation is right and implementation is wrong!

#2 Updated by Rob Nahf almost 13 years ago

also change the return type of CNIdentity.listSubjects() from SubjectList to the more informative SubjectInfo()

#3 Updated by Dave Vieglais almost 13 years ago

CNCore.ping and MNCore.ping do not return a message body. The timestamp is returned in the Date header, as described in the docs.

#4 Updated by Dave Vieglais almost 13 years ago

  • Status changed from New to In Progress

#5 Updated by Dave Vieglais almost 13 years ago

  • Status changed from In Progress to Closed

Completed, svn revision 6759.

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 14.8 MB)