Quantcast
Channel: Recent Threads — Xamarin Community Forums
Viewing all articles
Browse latest Browse all 204402

Documentation not generated in bindings project.xml

$
0
0

I am trying to generate documentation for the android library in Xamarin in C#.
I have android library written in Kotlin and generated javadoc. The javaadoc is generated using dokka - Documentation engine for Kotlin

I have generated Java bindings in Xamarin for my android library. And I added javadoc in Java bindings project in Visual Studio. Set index.html in javadoc to JavaDocIndex in Java bindings project. I also have also set to true in the bindings project.

After building bindings project, .xml is generated in the bin\Debug folder.

In the xml, documentation for some of the apis is missing and displays 'To be added' in the tags of xml file. In java doc, I am able to view the description of all apis. But, not in the generated xml file.

Eg: Init() does not have description for the summary and parameters and instead displays 'To be added'. In the .xml

<member name="M:Com.Sdk.Init(Android.Content.Context,System.String,Com.Sdk.Util.DSMode)">
            <param name="context">To be added.</param>
            <param name="paramA">To be added.</param>
            <param name="mode">To be added.</param>
            <summary>To be added.</summary>
            <returns>To be added.</returns>
            <remarks>To be added.</remarks>
</member>

During the build of bindings project, it displays the following log:

IMPORTJAVADOC : warning JavadocToMDoc0004: Could not find JavaDoc for member 'init(android.content.Context, java.lang.String, com.sdk.util.DSMode)' - managed member is 'Test Com.Sdk.Test::Init(Android.Content.Context,System.String,Com.Sdk.Util.DSMode)' [sdkbinding.csproj]
Can you let me know how to generate documentation for all the apis in the binding xml, which includes description of the apis.

Viewing all articles
Browse latest Browse all 204402

Trending Articles



<script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>