From f8f7ae14bec054170d69d8fd4de0c453b3c34798 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Sun, 24 Jul 2016 20:09:48 -0400 Subject: add initial api documentation for C++, C, and Python generated with sphinx, breathe, and doxygen mostly working on the framework, lots left undocumented --- api-docs/.atom-build.js | 65 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 api-docs/.atom-build.js (limited to 'api-docs/.atom-build.js') 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 = "(?[\\/0-9a-zA-Z\\._]+):(?\\d+):(?\\d+):\\s+(?.+)"; + 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 = "(?.+)\\((?\\d+)\\): (?.+)"; + 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}" + } + } + }; +} -- cgit v1.3.1