From 95c3d05239a4cd5bdc5cf5be419f5102d1afe4ab Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Sat, 22 Nov 2008 06:59:34 +0000 Subject: [PATCH] Save research on Xcode docsets. --- TODO | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++- mxml.xml | 2 +- 2 files changed, 64 insertions(+), 2 deletions(-) diff --git a/TODO b/TODO index a2558f4..1990614 100644 --- a/TODO +++ b/TODO @@ -1,4 +1,4 @@ -TODO - 2008-01-25 +TODO - 2008-11-19 ----------------- - Add access methods and make node structure opaque. @@ -8,3 +8,65 @@ TODO - 2008-01-25 -- Make this the core implementation which the C API accesses? -- Class would allow for subclassing, is that necessary? - Binary XML support??? + - Add "--docset foo" option to generate an Xcode docset bundle, + "--feed-name bar" and "--feed-url http://..." + +docset + Contents + Info.plist + Nodes.xml + Resources + Documents + index.html + Tokens.xml + +Run /Developer/usr/bin/docsetutil to generate index files + +Info.plist: + DocSetFeedName ("cups.org", "Easy Software Products", etc.) + DocSetFeedURL ("") + CFBundleName (title) + CFBundleIdentifier (docset) + +Nodes.xml: + + + + + name + index.html + + + + +Tokens.xml: + + + + + + c or cpp + type + classname + + anchor string + summary + prototype + + OR + //apple_ref/lang/type/scope/name + + + ... + + +types: http://developer.apple.com/documentation/DeveloperTools/Conceptual/HeaderDoc/anchors/chapter_950_section_2.html + +tag struct, union, or enum tag +econst an enumerated constant—that is, a symbol defined inside an enum +tdef typedef name (or Pascal type) +data global or file-static data +func function name (without '()') +cl class name +instm an instance method 'clm' a class (or static [in java or c++]) method +func C++ scoped function (i.e. not extern 'C'); includes return type and signature. diff --git a/mxml.xml b/mxml.xml index fabfe55..4f474da 100644 --- a/mxml.xml +++ b/mxml.xml @@ -1,4 +1,4 @@ - + Add a node to a tree.