Can the API and User documentation be done for this project?
It looks like the client library components are available for download. A user documentation on how to use the API would be quite helpful.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
LAYOUT OF THE PACKAGE
------------------------------
The IHE library is made up of three packages which build into 4 distinct jars.
>Infra
This package is made up of utility classes. Some of these classes may get replaced over time with existing open source utility classes. This package is built into two separate libraries infra-init and infra-util.
>ConnectionLib
This package contains classes that are healthcare related, but not specific to the IHE infrastructure.
>IheConnectionLib
This package contains the classes that implement the IHE profiles.
There is also a directory named repo, which houses 3rd party jars required by the infra package, and it is where all of the jars are put by default.
Note: The ConnectionLib and IheConnectionLib packages each have a lib directory which contains their dependencies. To use the IHE library, you must include the 3rd party jars from the repo and from the IheConnectionLib and ConnectionLib lib directories.
Not all of the unit tests currently work. It is our plan to focus on fixing the unit tests as quickly as possible.
The technical documents and configuration descriptions are quite useful. Can we have these files & samples listed in the Downloads section so that instead of copy pasting the config & others, the same can be downloaded as a package?
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Can the API and User documentation be done for this project?
It looks like the client library components are available for download. A user documentation on how to use the API would be quite helpful.
user documentation will be greatly appreciated.
Currently, there is no user documentation. But an architectural design doc including API is available under the doc package.
I got these info from the /trunk/HACKING.txt
------------------------------------------------------------------------------------------------
LAYOUT OF THE PACKAGE
------------------------------
The IHE library is made up of three packages which build into 4 distinct jars.
>Infra
This package is made up of utility classes. Some of these classes may get replaced over time with existing open source utility classes. This package is built into two separate libraries infra-init and infra-util.
>ConnectionLib
This package contains classes that are healthcare related, but not specific to the IHE infrastructure.
>IheConnectionLib
This package contains the classes that implement the IHE profiles.
There is also a directory named repo, which houses 3rd party jars required by the infra package, and it is where all of the jars are put by default.
Note: The ConnectionLib and IheConnectionLib packages each have a lib directory which contains their dependencies. To use the IHE library, you must include the 3rd party jars from the repo and from the IheConnectionLib and ConnectionLib lib directories.
Not all of the unit tests currently work. It is our plan to focus on fixing the unit tests as quickly as possible.
--------------------------------------------------------------------------------------------
It looks like unit test codes need some fixing? Anyone has a plan on this?
This is an very old documentation. Unit tests have already been fixed.
The new documentation will be posted on this project website rather than word or text documents.
The new user documentation on the Project Website looks good and informative. http://braid.sourceforge.net.
The technical documents and configuration descriptions are quite useful. Can we have these files & samples listed in the Downloads section so that instead of copy pasting the config & others, the same can be downloaded as a package?
Infra.jar is not used by Braid.
Braid contains only base.jar and and ihe.jar.