mirror of
https://github.com/michaelrsweet/mxml.git
synced 2025-04-07 11:12:08 +00:00
Save research on Xcode docsets.
This commit is contained in:
parent
32c05d0617
commit
95c3d05239
64
TODO
64
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:
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<DocSetNodes version="1.0">
|
||||
<TOC>
|
||||
<Node id="1" type="folder">
|
||||
<Name>name</Name>
|
||||
<Path>index.html</Path>
|
||||
</Node>
|
||||
</TOC>
|
||||
</DocSetNodes>
|
||||
|
||||
Tokens.xml:
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<File path="index.html">
|
||||
<Token>
|
||||
<TokenIdentifier>
|
||||
<Name></Name>
|
||||
<APILanguage>c or cpp</APILanguage>
|
||||
<Type>type</Type>
|
||||
<Scope>classname</Scope>
|
||||
</TokenIdentifier>
|
||||
<Anchor>anchor string</Anchor>
|
||||
<Abstract>summary</Abstract>
|
||||
<Declaration>prototype</Declaration>
|
||||
|
||||
OR
|
||||
<TokenIdentifier>//apple_ref/lang/type/scope/name</TokenIdentifier>
|
||||
|
||||
</Token>
|
||||
...
|
||||
</File>
|
||||
|
||||
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.
|
||||
|
2
mxml.xml
2
mxml.xml
@ -1,4 +1,4 @@
|
||||
<?xml version="1.0"?>
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<mxmldoc xmlns="http://www.easysw.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.minixml.org/mxmldoc.xsd">
|
||||
<function name="mxmlAdd">
|
||||
<description>Add a node to a tree.
|
||||
|
Loading…
Reference in New Issue
Block a user