search

rhx / SwiftGtk

A Swift wrapper around gtk-3.x and gtk-4.x that is largely auto-generated from gobject-introspection
https://rhx.github.io/SwiftGtk/
BSD 2-Clause "Simplified" License
317 stars 26 forks source link

provide API documentation #6

Closed medovina closed 4 years ago

medovina commented 7 years ago

Again, SwiftGtk is great!

I can often guess the name and parameters of a SwiftGtk wrapper function based on the corresponding name and parameters in the GTK documentation, but sometimes it's not immediately obvious and I have to look through the wrapper source files to find the function. So it would be nice if SwiftGtk provided reference documentation for its API, ideally in a format like that at http://swiftdoc.org/ .

lf-araujo commented 7 years ago

@medovina have you successfuly created any app with swiftgtk that you can showcase?

medovina commented 7 years ago

@lf-araujo No - I've just begun playing with SwiftGTK in the last week. The toy experiments I've written so far have worked well, however.

carlhung commented 5 years ago

It would be great if more tutorials can be added.

rhx commented 4 years ago

API documentation is now available on https://rhx.github.io/SwiftGtk

Also, the generated sources now contain SwiftDoc style documentation, so if you use ./xcodegen.sh to generate an Xcode project for your package, the documentation should show up in the help viewer.