Skip to content

Commit

Permalink
[cw|#6] quickly document on xaqt library on a high level
Browse files Browse the repository at this point in the history
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.
16 changes: 16 additions & 0 deletions docs.md
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)
```

0 comments on commit 670c628

Please sign in to comment.