Sdk: dart:ffi documentation on the dart website

Created on 25 Jan 2019  路  8Comments  路  Source: dart-lang/sdk

Write documentation or tutorials for dart:ffi

  • [x] A library description.
  • [x] Good documentation for all methods/functions.
  • [x] Samples with good documentation which are executed to ensure they keep working.
area-library library-ffi

Most helpful comment

We might also need a tutorial on binding to Android/iOS libraries within Flutter.

All 8 comments

We might also need a tutorial on binding to Android/iOS libraries within Flutter.

We should also take care to document (or link to documentation for) the dlopen/LoadLibraryW behaviors, since they have already confused some users. For example:

  1. Where libraries are searched for
  2. How library dependencies are located and loaded
  3. ABI & library versioning

/cc @mkustermann

We need to flip the switch to turn on the API docs when the API is sufficiently stable.

/cc @kwalrath

@kwalrath is there anything that needs to happen on the documentation side before D26?

Otherwise we can flip the switch to turn on the API docs.

Removing D26 milestone since this is not blocking the release.

@kwalrath is there anything that needs to happen on the documentation side before D26?

Not to my knowledge. @mit-mit would be the judge.

Otherwise we can flip the switch to turn on the API docs.

SGTM. I'd like to be able to point to them.

API docs are generated already: $ tools/bots/dart_sdk.py api_docs -n try generates docs in out/ReleaseX64/gen-dartdocs/dart-ffi/dart-ffi-library.html.

Was this page helpful?
0 / 5 - 0 ratings