Skip to content

Generator support for api.xml style java docs for parameter names #920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonpryor merged 7 commits into from
Nov 3, 2017
Merged

Generator support for api.xml style java docs for parameter names #920

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2fa5338
[Xamarin.Android.Build.Tasks] Add ApiXmlPaths to ClassParse
Redth Oct 6, 2017
73598ce
Bump java.interop
Redth Oct 30, 2017
1209f1c
Condense multi task parameters into one itemgroup
Redth Oct 31, 2017
3fb4e3d
Add AndroidDocumentation to AvailableItemName grp
Redth Oct 31, 2017
140e187
Fix item group include
Redth Oct 31, 2017
72d0f56
Revert bump to java.interop
Redth Oct 31, 2017
d048080
Revert AndroidDocumentationPath creation
Redth Nov 3, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 3 additions & 25 deletions src/Xamarin.Android.Build.Tasks/Tasks/ClassParse.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,43 +21,21 @@ public class ClassParse : Task
[Required]
public ITaskItem[] SourceJars { get; set; }

public ITaskItem[] JavaDocPaths { get; set; }

public ITaskItem[] Java7DocPaths { get; set; }

public ITaskItem[] Java8DocPaths { get; set; }

public ITaskItem[] DroidDocPaths { get; set; }

public ITaskItem [] DroidDoc2Paths { get; set; }

public ITaskItem [] JavaDocs { get; set; }

public IEnumerable<ITaskItem> DocsPaths {
get {
Func<ITaskItem[],IEnumerable<ITaskItem>> f = l => l ?? Enumerable.Empty<ITaskItem> ();
return f (JavaDocPaths).Concat (f (Java7DocPaths)).Concat (f (Java8DocPaths)).Concat (f (DroidDocPaths)).Concat (f (DroidDoc2Paths)).Concat (f (JavaDocs));
}
}
public ITaskItem [] DocumentationPaths { get; set; }

public override bool Execute ()
{
Log.LogDebugMessage ("ClassParse Task");
Log.LogDebugMessage (" OutputFile: {0}", OutputFile);
Log.LogTaskItems (" SourceJars: ", SourceJars);
Log.LogTaskItems (" JavaDocPaths: ", JavaDocPaths);
Log.LogTaskItems (" Java7DocPaths: ", Java7DocPaths);
Log.LogTaskItems (" Java8DocPaths: ", Java8DocPaths);
Log.LogTaskItems (" DroidDocPaths: ", DroidDocPaths);
Log.LogTaskItems (" DroidDoc2Paths: ", DroidDoc2Paths);
Log.LogTaskItems (" JavaDocs: ", JavaDocs);
Log.LogTaskItems (" DocumentationPaths: ", DocumentationPaths);

using (var output = new StreamWriter (OutputFile, append: false,
encoding: new UTF8Encoding (encoderShouldEmitUTF8Identifier: false))) {
Bytecode.Log.OnLog = LogEventHandler;
var classPath = new Bytecode.ClassPath () {
ApiSource = "class-parse",
DocumentationPaths = (DocsPaths ?? Enumerable.Empty<ITaskItem> ()).Select(x => x.ItemSpec)
DocumentationPaths = (DocumentationPaths ?? Enumerable.Empty<ITaskItem> ()).Select(x => x.ItemSpec)
};
foreach (var jar in SourceJars) {
if (Bytecode.ClassPath.IsJarFile (jar.ItemSpec)) {
Expand Down
16 changes: 10 additions & 6 deletions src/Xamarin.Android.Build.Tasks/Xamarin.Android.Bindings.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,16 +366,20 @@ Copyright (C) 2012 Xamarin Inc. All rights reserved.
<Output TaskParameter="Include" ItemName="ReferenceJar" />
</CreateItem>

<ItemGroup>
<_AndroidDocumentationPath Include="@(JavaDocIndex)" />
<_AndroidDocumentationPath Include="$(JavaDocPaths)" />
<_AndroidDocumentationPath Include="$(Java7DocPaths)" />
<_AndroidDocumentationPath Include="$(Java8DocPaths)" />
<_AndroidDocumentationPath Include="$(DroidDocPaths)" />
<_AndroidDocumentationPath Include="@(JavaDocJar->'$(IntermediateOutputPath)javadocs\%(FileName)')" />
</ItemGroup>

<!-- Extract the API from the .jar file and store as .xml, using either class-parse or jar2xml -->

<ClassParse Condition="'$(AndroidClassParser)' == 'class-parse'"
OutputFile="$(ApiOutputFile).class-parse"
SourceJars="@(EmbeddedJar);@(InputJar)"
JavaDocPaths="$(JavaDocPaths)"
Java7DocPaths="$(Java7DocPaths)"
Java8DocPaths="$(Java8DocPaths)"
DroidDocPaths="$(DroidDocPaths)"
JavaDocs="@(JavaDocJar->'$(IntermediateOutputPath)javadocs\%(FileName)')"
DocumentationPaths="@(_AndroidDocumentationPath)"
/>

<BindingsGenerator Condition="'$(AndroidClassParser)' == 'class-parse'"
Expand Down