mirror of
https://github.com/opennetworkinglab/onos.git
synced 2025-10-24 13:51:27 +02:00
Start of client-side Framework Library documentation.
Change-Id: I503c0613db97fb181f9e97847bcca0b6ace564c2
This commit is contained in:
parent
9ce0e40b9a
commit
e51a5e9f8d
33
web/gui/src/main/webapp/_doc/fw/README.fn.md
Normal file
33
web/gui/src/main/webapp/_doc/fw/README.fn.md
Normal file
@ -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)_
|
||||
13
web/gui/src/main/webapp/_doc/view/topo/README.md
Normal file
13
web/gui/src/main/webapp/_doc/view/topo/README.md
Normal file
@ -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.
|
||||
13
web/gui/src/main/webapp/_doc/view/topo2/README.md
Normal file
13
web/gui/src/main/webapp/_doc/view/topo2/README.md
Normal file
@ -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.
|
||||
Loading…
x
Reference in New Issue
Block a user