ryujinx/Opentk
1
0
Fork 0
mirror of https://github.com/Ryujinx/Opentk.git synced 2025-02-02 15:41:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

[Bind] Make documentation output closer to previous xslt implementation

Browse source
This commit is contained in:
thefiddler 2014-03-31 10:10:56 +02:00
parent 9012101e8c
commit 8001d62599
1 changed files with 34 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
Source/Bind/CSharpSpecWriter.cs
View file

@ -329,8 +329,24 @@ namespace Bind
category = String.Format("[requires: {0}]", "v" + f.Version + " or " + f.Category);
}
sw.WriteLine("/// <summary>{0}{1} {2}</summary>",
category, warning, docs.Summary);
// Write function summary
sw.Write("/// <summary>");
if (!String.IsNullOrEmpty(category) || !String.IsNullOrEmpty(warning))
{
sw.Write(WriteOptions.NoIndent, "{0}{1}", category, warning);
if (!String.IsNullOrEmpty(docs.Summary))
{
sw.WriteLine();
sw.WriteLine("/// {0}", docs.Summary);
sw.WriteLine("/// </summary>");
}
else
{
sw.WriteLine(WriteOptions.NoIndent, "</summary>");
}
}
// Write function parameters
for (int i = 0; i < f.Parameters.Count; i++)
{
var param = f.Parameters[i];
@ -357,14 +373,26 @@ namespace Bind
{
Console.Error.WriteLine(
"[Warning] Parameter '{0}' in function '{1}' has incorrect doc name '{2}'",
param.Name, f.Name, docparam.Name);
param.RawName, f.Name, docparam.Name);
}
// Note: we use param.Name, because the documentation sometimes
// uses different names than the specification.
sw.WriteLine("/// <param name=\"{0}\">{1} {2}</param>",
param.Name, length, docparam.Documentation);
sw.Write("/// <param name=\"{0}\">", param.Name);
if (!String.IsNullOrEmpty(length))
{
sw.Write(WriteOptions.NoIndent, "{0}", length);
}
if (!String.IsNullOrEmpty(docparam.Documentation))
{
sw.WriteLine(WriteOptions.NoIndent, " ");
sw.WriteLine("/// {0}", docparam.Documentation);
sw.WriteLine("/// </param>");
}
else
{
sw.WriteLine(WriteOptions.NoIndent, "</param>");
}
}
else
{