ryujinx/GtkSharp
1
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2025-11-04 08:24:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Remove obsolete gen-finalize-docs.cs tool

Browse source 
It was used to automatically document the Finalize methods, which do not
exist anymore. We are now using the standard Dispose pattern, and the
Dispose methods only appear in a few places, so they can be documented
manually.
This commit is contained in:
Bertrand Lorentz 2013-12-04 21:42:27 +01:00
parent 087659639a
commit b519e50a99
1 changed files with 0 additions and 105 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

105
doc/gen-finalize-docs.cs
View file

@ -1,105 +0,0 @@
// gen-finalize-docs.cs - Generate documentation for Finalize method.
//
// Author: John Luke <john.luke@gmail.com>
//
// Copyright (c) 2004 Novell, Inc.
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of version 2 of the GNU General Public
// License as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public
// License along with this program; if not, write to the
// Free Software Foundation, Inc., 59 Temple Place - Suite 330,
// Boston, MA 02111-1307, USA.
namespace GtkSharp.Docs
{
using System;
using System.Collections;
using System.IO;
using System.Reflection;
using System.Xml;
using System.Xml.XPath;
public class GenFinalizeDocs
{
public static int Main (string[] args)
{
XmlDocument api_doc = new XmlDocument ();
foreach (string arg in args)
{
Assembly assembly;
try
{
assembly = Assembly.LoadFile (arg);
}
catch (XmlException e)
{
Console.WriteLine (e);
return 1;
}
foreach (Type t in assembly.GetTypes ())
{
if (!t.IsSubclassOf (typeof (GLib.Object)))
continue;
MethodInfo mi = t.GetMethod ("Finalize", BindingFlags.NonPublic | BindingFlags.Instance);
if (mi == null)
continue;
string filename = "en/" + t.Namespace + "/" + t.Name + ".xml";
try
{
Stream stream = File.OpenRead (filename);
api_doc.Load (stream);
stream.Close ();
Console.WriteLine ("opened:" + filename);
}
catch (XmlException e)
{
Console.WriteLine (e);
return 1;
}
XPathNavigator api_nav = api_doc.CreateNavigator ();
XPathNodeIterator iter = api_nav.Select ("/Type/Members/Member[@MemberName='Finalize']");
if (iter.MoveNext ())
{
XmlElement elem = ((IHasXmlNode)iter.Current).GetNode () as XmlElement;
XmlElement summ = elem ["Docs"] ["summary"];
XmlElement rem = elem ["Docs"] ["remarks"];
string summary = summ.InnerXml;
string remarks = rem.InnerXml;
if (summary == "To be added" && remarks == "To be added")
{
summ.InnerXml = "Disposes the resources associated with this <see cref=\"T:" + t + "\"/> object.";
rem.InnerXml = String.Empty;
}
else
{
Console.WriteLine ("Member had docs: Finalize");
}
}
else
{
Console.WriteLine ("Member not found: Finalize");
}
api_doc.Save (filename);
}
}
return 0;
}
}
}