Generate docs when using library mode

.gitignore

@@ -6,3 +6,4 @@ xcuserdata
 docs/manual/src/internals/api
 examples/app/ios/Generated
 examples/app/ios/IOSApp.xcodeproj/project.xcworkspace/xcshareddata/
+.direnv

docker/cargo-docker.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # Key points for these cmd-line args:
 #  * run a transient image that deletes itself on successful completion

uniffi_bindgen/src/bindings/kotlin/templates/ErrorTemplate.kt

@@ -3,10 +3,12 @@
 {%- let canonical_type_name = type_|error_canonical_name %}
 
 {% if e.is_flat() %}
+{% let struct = e %}{% include "StructureDocsTemplate.kt" %}
 sealed class {{ type_name }}(message: String): Exception(message){% if contains_object_references %}, Disposable {% endif %} {
         // Each variant is a nested class
         // Flat enums carries a string error message, so no special implementation is necessary.
         {% for variant in e.variants() -%}
+        {% include "EnumVariantDocsTemplate.kt" %}
         class {{ variant|error_variant|type_name }}(message: String) : {{ type_name }}(message)
         {% endfor %}
 
@@ -15,9 +17,11 @@ sealed class {{ type_name }}(message: String): Exception(message){% if contains_
     }
 }
 {%- else %}
+{% let struct = e %}{% include "StructureDocsTemplate.kt" %}
 sealed class {{ type_name }}: Exception(){% if contains_object_references %}, Disposable {% endif %} {
     // Each variant is a nested class
     {% for variant in e.variants() -%}
+    {% include "EnumVariantDocsTemplate.kt" %}
     {%- let variant_name = variant|error_variant|type_name %}
     class {{ variant_name }}(
         {% for field in variant.fields() -%}

uniffi_bindgen/src/bindings/kotlin/templates/ObjectTemplate.kt

@@ -3,6 +3,7 @@
 {%- let (interface_name, impl_class_name) = obj|object_names %}
 {%- let methods = obj.methods() %}
 
+{% let struct = obj %}{% include "StructureDocsTemplate.kt" %}
 {% include "Interface.kt" %}
 
 class {{ impl_class_name }}(
@@ -33,6 +34,8 @@ class {{ impl_class_name }}(
     }
 
     {% for meth in obj.methods() -%}
+    {%- let func = meth -%}
+    {%- include "FunctionDocsTemplate.kt" -%}
     {%- match meth.throws_type() -%}
     {%- when Some with (throwable) %}
     @Throws({{ throwable|error_type_name }}::class)

uniffi_bindgen/src/bindings/python/templates/EnumVariantDocsTemplate.py

@@ -1,6 +1,6 @@
 {% match variant.documentation() -%}
-{% when Some with (docs) %}"""
+  {% when Some with (docs) %}"""
 {% for line in docs.lines() %}    {{ line }} 
 {% endfor %}    """
-{%- when None %}
-{%- endmatch %}
+  {%- when None %}
+{%- endmatch %}

uniffi_bindgen/src/bindings/python/templates/ErrorTemplate.py

@@ -9,15 +9,17 @@ class {{ type_name }}(Exception):
 
 _UniffiTemp{{ type_name }} = {{ type_name }}
 
-class {{ type_name }}:  # type: ignore
+class {{ type_name }}:  # type: ignore{% let struct = e %}{% include "StructureDocsTemplate.py" %}
     {%- for variant in e.variants() -%}
     {%- let variant_type_name = variant.name()|class_name -%}
     {%- if e.is_flat() %}
     class {{ variant_type_name }}(_UniffiTemp{{ type_name }}):
+        {% include "ErrorVariantDocsTemplate.py" %}
         def __repr__(self):
             return "{{ type_name }}.{{ variant_type_name }}({})".format(repr(str(self)))
     {%- else %}
     class {{ variant_type_name }}(_UniffiTemp{{ type_name }}):
+        {% include "ErrorVariantDocsTemplate.py" %}
         def __init__(self{% for field in variant.fields() %}, {{ field.name()|var_name }}{% endfor %}):
             {%- if variant.has_fields() %}
             super().__init__(", ".join([

uniffi_bindgen/src/bindings/python/templates/ErrorVariantDocsTemplate.py

@@ -0,0 +1,6 @@
+{% match variant.documentation() -%}
+  {% when Some with (docs) %}"""
+    {% for line in docs.lines() %}    {{ line }} 
+    {% endfor %}    """
+  {%- when None %}
+{%- endmatch %}

uniffi_bindgen/src/bindings/python/templates/macros.py

@@ -101,6 +101,8 @@
 {%  if meth.is_async() %}
 
     def {{ py_method_name }}(self, {% call arg_list_decl(meth) %}):
+        {%- let func = meth -%}
+        {% include "MethodDocsTemplate.py" %}
         {%- call setup_args_extra_indent(meth) %}
         return _uniffi_rust_call_async(
             _UniffiLib.{{ meth.ffi_func().name() }}(
@@ -131,6 +133,8 @@ def {{ py_method_name }}(self, {% call arg_list_decl(meth) %}):
 {%-         when Some with (return_type) %}
 
     def {{ py_method_name }}(self, {% call arg_list_decl(meth) %}) -> "{{ return_type|type_name }}":
+        {%- let func = meth -%}
+        {% include "MethodDocsTemplate.py" %}
         {%- call setup_args_extra_indent(meth) %}
         return {{ return_type|lift_fn }}(
             {% call to_ffi_call_with_prefix("self._pointer", meth) %}
@@ -139,6 +143,8 @@ def {{ py_method_name }}(self, {% call arg_list_decl(meth) %}) -> "{{ return_typ
 {%-         when None %}
 
     def {{ py_method_name }}(self, {% call arg_list_decl(meth) %}):
+        {%- let func = meth -%}
+        {% include "MethodDocsTemplate.py" %}
         {%- call setup_args_extra_indent(meth) %}
         {% call to_ffi_call_with_prefix("self._pointer", meth) %}
 {%      endmatch %}

uniffi_bindgen/src/bindings/ruby/templates/ErrorTemplate.rb

@@ -22,13 +22,16 @@ def to_s
 {%- for e in ci.enum_definitions() %}
 {% if ci.is_name_used_as_error(e.name()) %}
 {% if e.is_flat() %}
+{% include "EnumDocsTemplate.rb" -%}
 class {{ e.name()|class_name_rb }}
     {%- for variant in e.variants() %}
+    {% include "EnumVariantDocsTemplate.rb" -%}
     {{ variant.name()|class_name_rb }} = Class.new StandardError
     {%- endfor %}
 {% else %}
 module {{ e.name()|class_name_rb }}
   {%- for variant in e.variants() %}
+  {% include "EnumVariantDocsTemplate.rb" -%}
   class {{ variant.name()|class_name_rb }} < StandardError
     def initialize({% for field in variant.fields() %}{{ field.name()|var_name_rb }}{% if !loop.last %}, {% endif %}{% endfor %})
         {%- for field in variant.fields() %}

uniffi_bindgen/src/bindings/swift/templates/ErrorTemplate.swift

@@ -1,13 +1,16 @@
+{% let struct = e %}{% include "StructureDocsTemplate.swift" %}
 public enum {{ type_name }} {
 
     {% if e.is_flat() %}
     {% for variant in e.variants() %}
+    {% include "EnumVariantDocsTemplate.swift" %}
     // Simple error enums only carry a message
     case {{ variant.name()|class_name }}(message: String)
     {% endfor %}
 
     {%- else %}
     {% for variant in e.variants() %}
+    {% include "EnumVariantDocsTemplate.swift" %}
     case {{ variant.name()|class_name }}{% if variant.fields().len() > 0 %}({% call swift::field_list_decl(variant) %}){% endif -%}
     {% endfor %}
 

uniffi_bindgen/src/bindings/swift/templates/ObjectTemplate.swift

@@ -2,6 +2,7 @@
 {%- let (protocol_name, impl_class_name) = obj|object_names %}
 {%- let methods = obj.methods() %}
 
+{% let struct = obj %}{% include "StructureDocsTemplate.swift" %}
 {% include "Protocol.swift" %}
 
 public class {{ impl_class_name }}: {{ protocol_name }} {
@@ -41,6 +42,8 @@ public class {{ impl_class_name }}: {{ protocol_name }} {
     {% for meth in obj.methods() -%}
     {%- if meth.is_async() %}
 
+    {%- let func = meth -%}
+    {%- include "FunctionDocsTemplate.swift" %}
     public func {{ meth.name()|fn_name }}({%- call swift::arg_list_decl(meth) -%}) async {% call swift::throws(meth) %}{% match meth.return_type() %}{% when Some with (return_type) %} -> {{ return_type|type_name }}{% when None %}{% endmatch %} {
         return {% call swift::try(meth) %} await uniffiRustCallAsync(
             rustFutureFunc: {

uniffi_bindgen/src/library_mode.rs

@@ -100,7 +100,10 @@ pub fn generate_external_bindings<T: BindingGenerator>(
         }
     }
 
-    for source in sources.iter() {
+    for source in &mut sources {
+        // Assumes a lib.rs for the source package containing bindings
+        let path = &source.package.manifest_path.with_file_name("src/lib.rs");
+        source.config.update_documentation(&mut source.ci, path)?;
         binding_generator.write_bindings(&source.ci, &source.config, out_dir)?;
     }