Code

API docs improvements#942

Code

Merged

dherman merged 27 commits intomainneon-bindings/neon:mainfrom apidoc-examplesneon-bindings/neon:apidoc-examplesCopy head branch name to clipboardFeb 3, 2023

+616-78

Commits

Commits on Nov 13, 2022

• API docs for JsValue

  dherman

  committed
  8607a77

  Copy full SHA for 8607a77

Commits on Nov 14, 2022

• Align the wording style of doc summaries for all entires in neon::types.

  dherman

  committed
  ce33685

  Copy full SHA for ce33685

• Remove redundant markdown.

  dherman

  committed
  977f1cd

  Copy full SHA for 977f1cd

Commits on Nov 19, 2022

• JsArray example and method docs.

  dherman

  committed
  fd50eea

  Copy full SHA for fd50eea

• Add explicit JsArray type annotation to code example

  dherman

  committed
  942dc88

  Copy full SHA for 942dc88

• JsFunction API docs

  dherman

  committed
  21df710

  Copy full SHA for 21df710

Commits on Nov 22, 2022

• API docs for JsUndefined

  dherman

  committed
  8aca955

  Copy full SHA for 8aca955

• API docs for:

  Show description for 68356d8
  dherman

  committed
  68356d8

  Copy full SHA for 68356d8

• JsError example

  dherman

  committed
  f125256

  Copy full SHA for f125256

Commits on Nov 23, 2022

• JsDate API docs

  dherman

  committed
  13fe178

  Copy full SHA for 13fe178

Commits on Nov 24, 2022

• Use easy-cast library to clean up the numeric conversion logic in the Date example.

  dherman

  committed
  f774d76

  Copy full SHA for f774d76

Commits on Dec 23, 2022

• Merge branch 'main' into apidoc-examples

  dherman

  committed
  3bcac26

  Copy full SHA for 3bcac26

• Fix failing doc-tests:

  Show description for 94ead0d
  dherman

  committed
  94ead0d

  Copy full SHA for 94ead0d

Commits on Jan 7, 2023

• Example for JsFuture

  dherman

  committed
  c43c319

  Copy full SHA for c43c319

Commits on Jan 8, 2023

• Examples for JsPromise

  dherman

  committed
  5190416

  Copy full SHA for 5190416

• Delete trailing whitespace

  dherman

  committed
  e93a6ba

  Copy full SHA for e93a6ba

Commits on Jan 9, 2023

• Examples for JsString

  dherman

  committed
  c063e50

  Copy full SHA for c063e50

• Use easy-cast for the Promise example

  dherman

  committed
  a531021

  Copy full SHA for a531021

• - Link Deferred to examples in JsPromise and JsFuture

  Show description for 342d2be
  dherman

  committed
  342d2be

  Copy full SHA for 342d2be

Commits on Jan 23, 2023

• copy edit: "type of JS smart pointer" -> "JS smart pointer"

  Show description for 6686822
  

  dherman

  and

  kjvalencik

  authored
  6686822

  Copy full SHA for 6686822

• Simplification for Date example code

  Show description for 7904f1b
  

  dherman

  and

  kjvalencik

  authored
  7904f1b

  Copy full SHA for 7904f1b

• Simplify example with call_method_with

  Show description for cdd8cc8
  

  dherman

  and

  kjvalencik

  authored
  cdd8cc8

  Copy full SHA for cdd8cc8

• Simplify another example with call_method_with

  Show description for 1f332d6
  

  dherman

  and

  kjvalencik

  authored
  1f332d6

  Copy full SHA for 1f332d6

• Add "see also" reference from exec to call_with.

  Show description for 3945cba
  

  dherman

  and

  kjvalencik

  authored
  3945cba

  Copy full SHA for 3945cba

Commits on Jan 27, 2023

• Clarifying copy

  dherman

  committed
  e0055bd

  Copy full SHA for e0055bd

• Explain the role of Deferred in the Promise docs

  dherman

  committed
  4e35241

  Copy full SHA for 4e35241

• bugfix in doc comment code

  dherman

  committed
  498606a

  Copy full SHA for 498606a