From b519e50a990587ba89c29314cabf7a2724aeb3a0 Mon Sep 17 00:00:00 2001 From: Bertrand Lorentz Date: Wed, 4 Dec 2013 21:42:27 +0100 Subject: [PATCH] doc: Remove obsolete gen-finalize-docs.cs tool 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. --- doc/gen-finalize-docs.cs | 105 --------------------------------------- 1 file changed, 105 deletions(-) delete mode 100644 doc/gen-finalize-docs.cs diff --git a/doc/gen-finalize-docs.cs b/doc/gen-finalize-docs.cs deleted file mode 100644 index 9030198ff..000000000 --- a/doc/gen-finalize-docs.cs +++ /dev/null @@ -1,105 +0,0 @@ -// gen-finalize-docs.cs - Generate documentation for Finalize method. -// -// Author: John Luke -// -// 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 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; - } - } -} -