diff --git a/web/gui/src/main/webapp/_doc/fw/README.fn.md b/web/gui/src/main/webapp/_doc/fw/README.fn.md new file mode 100644 index 0000000000..99515f063c --- /dev/null +++ b/web/gui/src/main/webapp/_doc/fw/README.fn.md @@ -0,0 +1,33 @@ +Function Service +================ + +### Function Descriptions + +`fs.isF(f)` +* Returns the argument `f` if it is a function, `null` otherwise + +`fs.isA(a)` +* Returns the argument `a` if it is an array, `null` otherwise + +`fs.isS(s)` +* Returns the argument `s` if it is a string, `null` otherwise + +`fs.isO(o)` +* Returns the argument `o` if it is an object, `null` otherwise + +`fs.contains(a, x)` +* Returns the index of `x` if it is in the array `a`, otherwise returns `-1` + +`fs.areFunctions(api, fnNames)` +* `api`: API object to check +* `fnNames`: array of function names expected +* Returns `true` if functions defined on `api` _exactly matches_ `fnNames` list + +`fs.areFunctionsNonStrict(api, fnNames)` +* `api`: API object to check +* `fnNames`: array of function names expected +* Returns `true` if functions defined on `api` include _all_ `fnNames` list + +--- + +_(to be continued)_ \ No newline at end of file diff --git a/web/gui/src/main/webapp/_doc/view/topo/README.md b/web/gui/src/main/webapp/_doc/view/topo/README.md new file mode 100644 index 0000000000..f87c0c4add --- /dev/null +++ b/web/gui/src/main/webapp/_doc/view/topo/README.md @@ -0,0 +1,13 @@ +Topology API Documentation +========================== + +This directory (will eventually) contain a `README` file for each of the +services defined in the _Topology View_, documenting the APIs. + +`README.d3.md` + +`README.dialog.md` + +`README.event.md` + +etc. diff --git a/web/gui/src/main/webapp/_doc/view/topo2/README.md b/web/gui/src/main/webapp/_doc/view/topo2/README.md new file mode 100644 index 0000000000..8f94f108c0 --- /dev/null +++ b/web/gui/src/main/webapp/_doc/view/topo2/README.md @@ -0,0 +1,13 @@ +Topology 2 API Documentation +============================ + +This directory (will eventually) contain a `README` file for each of the +services defined in the _Topology 2 View_, documenting the APIs. + +`README.background.md` + +`README.breadcrumb.md` + +`README.collection.md` + +etc.