#9: API interface documentation
View
(Anonymous)
issuedata
Classification:
Bug
Topic:
Others
Importance:
High
Assigned to:
Created by: andre
Created at: 2007-10-01
progress
Deadline:
2007-10-15 21:02
Hours estimated:
0
Hours needed:
0
Percent done:
0
contact
Name:
David Nickerson
Description:
The original API IDL files (CellML_APISPEC.idl, CellML_events.idl, etc) contain a nice and somewhat useful comment at the top of each file to indicate just what the purpose of the interface being defined is. The newer interfaces (CCGS.idl, CUSES.idl, MaLaES.idl, etc) don't appear to contain any similar comments making it quite difficult to work out what they do. In lieu of more thorough documentation such comments would provide some minimal help to developers trying to get to grips with the API implementation.
Transcript
#1:
2007-10-01 21:05 (andre)
topic: "" ->
"Others"
importance: "medium" ->
"high"
title: "" ->
"API interface documentation"
description: "" ->
"The original API IDL files (CellML_APISPEC.idl, CellML_events.idl, etc) contain a nice and somewhat useful comment at the top of each file to indicate just what the purpose of the interface being defined is. The newer interfaces (CCGS.idl, CUSES.idl, MaLaES.idl, etc) don't appear to contain any similar comments making it quite difficult to work out what they do. In lieu of more thorough documentation such comments would provide some minimal help to developers trying to get to grips with the API implementation."
PloneCollectorNG (C) 2003-2004 by ZOPYX - Software Development and Consulting Andreas Jung