diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2016-07-24 20:09:48 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2016-07-24 20:09:48 -0400 |
| commit | f8f7ae14bec054170d69d8fd4de0c453b3c34798 (patch) | |
| tree | e19f73b8db0fc374b2d96c2121705f38302e6d5d /api-docs/.atom-build.js | |
| parent | b1900d6ebcc39738885f90fa9f18b28206a74947 (diff) | |
add initial api documentation for C++, C, and Python generated with sphinx, breathe, and doxygen mostly working on the framework, lots left undocumented
Diffstat (limited to 'api-docs/.atom-build.js')
| -rw-r--r-- | api-docs/.atom-build.js | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/api-docs/.atom-build.js b/api-docs/.atom-build.js new file mode 100644 index 00000000..dd277d4d --- /dev/null +++ b/api-docs/.atom-build.js @@ -0,0 +1,65 @@ +child_process = require('child_process');
+
+function run(result)
+{
+ if (!result)
+ return;
+
+ if (process.platform == "darwin")
+ child_process.spawn("/usr/bin/open", ["build/html/index.html"])
+ else if (process.platform == "linux")
+ child_process.spawn("/usr/bin/xdg-open", ["build/html/index.html"])
+ else
+ child_process.spawn("start", ["build\\html\\index.html"])
+}
+
+if ((process.platform == "darwin") || (process.platform == "linux"))
+{
+ matchStr = "(?<file>[\\/0-9a-zA-Z\\._]+):(?<line>\\d+):(?<col>\\d+):\\s+(?<message>.+)";
+ module.exports = {
+ cmd: "make html",
+ name: "build and show",
+ sh: true,
+ cwd: "{PROJECT_PATH}",
+ errorMatch: matchStr,
+ postBuild: run,
+ targets: {
+ "html": {
+ cmd: "make html",
+ sh: true,
+ cwd: "{PROJECT_PATH}",
+ errorMatch: matchStr,
+ },
+ "dummy": {
+ cmd: "make dummy",
+ sh: true,
+ cwd: "{PROJECT_PATH}"
+ }
+ }
+ };
+}
+else
+{
+ matchStr = "(?<file>.+)\\((?<line>\\d+)\\): (?<message>.+)";
+ module.exports = {
+ cmd: "make.bat html",
+ name: "build and show",
+ sh: true,
+ cwd: "{PROJECT_PATH}",
+ errorMatch: matchStr,
+ postBuild: run,
+ targets: {
+ "html": {
+ cmd: "make.bat html",
+ sh: true,
+ cwd: "{PROJECT_PATH}",
+ errorMatch: matchStr,
+ },
+ "dummy": {
+ cmd: "make.bat dummy",
+ sh: true,
+ cwd: "{PROJECT_PATH}"
+ }
+ }
+ };
+}
|