Skip to content

Commit

Permalink
split low-level API into separate module (#68)
Browse files Browse the repository at this point in the history
The low-level API wrappers now sit in a submodule LibSerialPort.wrap.

The high-level API currently still re-exports a few symbols from that
low-level API module, to preserve backwards compatibility.

This is due to

* my previously started attempt to merge the low and high-level
  APIs for the three functions sp_flush, sp_drain, and sp_output_waiting

* the fact that several high-level APIs currently still refer to
  enum types and constants defined by the low-level API

We may want to phase out either or both in future, for a cleaner
separation, and a more Julian high-level API.
  • Loading branch information
mgkuhn committed Aug 17, 2020
1 parent 75d6ddc commit 189cf36
Show file tree
Hide file tree
Showing 6 changed files with 810 additions and 740 deletions.
9 changes: 7 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
using Documenter, LibSerialPort
using Documenter, LibSerialPort, LibSerialPort.wrap

makedocs(sitename="LibSerialPort.jl")
makedocs(
sitename="LibSerialPort.jl",
format = Documenter.HTML(
prettyurls = get(ENV, "CI", nothing) == "true"
)
)
5 changes: 5 additions & 0 deletions docs/src/wrap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Low-level C API wrappers

```@autodocs
Modules = [LibSerialPort.wrap]
```
Loading

0 comments on commit 189cf36

Please sign in to comment.