Re: [OT] Versions, Documentation, Frameworks
Re: [OT] Versions, Documentation, Frameworks
- Subject: Re: [OT] Versions, Documentation, Frameworks
- From: Finlay Dobbie <email@hidden>
- Date: Tue, 26 Feb 2002 19:34:06 +0000
On Tuesday, February 26, 2002, at 08:12 AM, Cyril Godefroy wrote:
Second thing has to do with framework versions
(blabla.framework/versions). What use is this and where do I found doc
on this? To be used, the framework has to be installed, and I don't
want to mess afterwards with version problems.
Not really sure about this one, but I think it's documented in System
Overview.
On the same matter, is getting the version as simple as defining a
version in the topmost header and asking the framework what version it
uses?
Probably easiest if you define some constants in the headers (like
#define kQTKitVersion 14, #define kQTKitVersion1_0 10, etc) and have a
function QTKitVersion() or something to return the version of the
framework.
Also on the same matter, what are the situations that influence the
distribution of a framework by itself vs distribution with the app that
uses it? I hope (inginument I would say) that the framework should be
used by several apps and maybe putting it in /Library/frameworks or
/System/Library will eventually make it user to use.
NEVER PUT ANYTHING IN /SYSTEM/LIBRARY UNLESS YOU ARE SURE YOU HAVE TO
(like Kernel Extensions).
Could you clarify what you mean here, anyway? :-)
At last, a framework is pretty useless with proper documentation (spent
hours reading OF code to figure what was happening). Is docbook (` la
Darwin) the way to go? Are there apps to ease redaction of docbooks and
others to transform it to easily accessible html documentation? Are
there rules or examples I could take experience from?
Darwin doesn't really use DocBook (other than for their Darwin
Documentation Project HOWTO files), mostly it's HeaderDoc (which now has
Objective-C support,
http://www.opensource.apple.com/projects/headerdoc). There's also
AutoDoc, which is more established and Obj-C only
(
http://www.misckit.com).
-- Finlay
_______________________________________________
cocoa-dev mailing list | email@hidden
Help/Unsubscribe/Archives:
http://www.lists.apple.com/mailman/listinfo/cocoa-dev
Do not post admin requests to the list. They will be ignored.