-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[cw|#6] quickly document on
xaqt
library on a high level
Notes: * create godoc during this refactor and remove `docs.md`
- Loading branch information
connorwalsh
committed
Apr 28, 2018
1 parent
71abb25
commit 670c628
Showing
1 changed file
with
16 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# XAQT Library | ||
*TODO (cw|4.28.2018) create godocs instead of this file...these are mostly notes for myself during development.* | ||
|
||
# Public Types | ||
* **`xaqt.Context`**: entrypoint into all functionality. TODO Propose renaming? | ||
* **`xaqt.Compilers`**: list of compilters. Propose re-typing to `[]Compiler`. | ||
* **`xaqt.Message`**: details on success or failure of execution | ||
|
||
# Public Methods | ||
|
||
``` go | ||
func NewContext(xaqt.Compilers, ...option) // option should be public! | ||
func (ctx *Context) ReadCompilers(string) | ||
func (ctw *Context) Languages([]string) // rename -> GetSupportedLanguages ? | ||
func (ctw *Context) Evaluate(string, string, []string) | ||
``` |