Difference between revisions of "OpenEMR API"
From OpenEMR Project Wiki
Bradymiller (talk | contribs) (→API) |
Bradymiller (talk | contribs) |
||
| Line 14: | Line 14: | ||
*A related github repo can be found here: http://github.com/kevmccor/code-doc-oemr | *A related github repo can be found here: http://github.com/kevmccor/code-doc-oemr | ||
== Issues == | |||
*Directories/Files to ignore: | *Directories/Files to ignore: | ||
:*apidocs/ | :*apidocs/ | ||
| Line 25: | Line 26: | ||
:*interface/main/calendar/pnadodb/ | :*interface/main/calendar/pnadodb/ | ||
::* Reason - This is an embedded module and connector functions can be found at library/sql.inc | ::* Reason - This is an embedded module and connector functions can be found at library/sql.inc | ||
*Note that duplicate function names are not listed. Thus will need to ensure unique functions names in functions that are meant to be used in other scripts. | |||
Revision as of 08:54, 26 June 2012
Overview
- This is a project that was recently started to auto-document the OpenEMR codebase. The project is still in an early phase.
API
- Most recent API run can be found here: http://www.open-emr.org/apidocs/
- (Was completed with phpDocumentor using following command on ubuntu: sudo phpdoc -t apidocs -o HTML:frames:earthli -d . --ignore apidocs/,gacl/,phpmyadmin/,library/adodb/,interface/main/calendar/pnadodb/ --defaultpackagename OpenEMR --title "OpenEMR API Documentation" --sourcecode)
- Next run:
- Try to fix following parameter: --sourcecode (considered an unstable option and doesn't appear to be working) to get it to link to the source code (or figure out another mechanism)
- Will also try other documentation software.
Plan
- Sourceforge forum on this topic can be found here: http://sourceforge.net/projects/openemr/forums/forum/202506/topic/5355691
- A related github repo can be found here: http://github.com/kevmccor/code-doc-oemr
Issues
- Directories/Files to ignore:
- apidocs/
- Reason - This is the API docs directory
- gacl/
- Reason - This is an embedded module with an API already included. Additionally, connector functions can be found at library/acl.inc .
- phpmyadmin/
- Reason - This is an embedded application that does not communicate directly with OpenEMR.
- library/adodb/
- Reason - This is an embedded module and connector functions can be found at library/sql.inc
- interface/main/calendar/pnadodb/
- Reason - This is an embedded module and connector functions can be found at library/sql.inc
- Note that duplicate function names are not listed. Thus will need to ensure unique functions names in functions that are meant to be used in other scripts.
