Bug 552984

Summary: Add DevHelp docs to OpenChange
Product: [Fedora] Fedora Reporter: Milan Crha <mcrha>
Component: openchangeAssignee: Matthew Barnes <mbarnes>
Status: CLOSED RAWHIDE QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: low Docs Contact:
Priority: low    
Version: rawhideCC: mbarnes
Target Milestone: ---   
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2010-01-09 13:45:02 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Attachments:
Description Flags
changes in spec file
none
based on the one in dbus
none
generate-xml-doc.patch - enable xml doc and export all none

Description Milan Crha 2010-01-06 18:40:08 UTC
It will be nice to have DevHelp for OpenChange as well. It has its advantages from static html or man pages. I'm attaching couple patches to achieve that.
It's generated on F-11, but I guess very low changes would be required to adapt it for rawhide or such.

Comment 1 Milan Crha 2010-01-06 18:41:35 UTC
Created attachment 382044 [details]
changes in spec file

Comment 2 Milan Crha 2010-01-06 18:42:18 UTC
Created attachment 382045 [details]
based on the one in dbus

Comment 3 Milan Crha 2010-01-06 18:43:23 UTC
Created attachment 382046 [details]
generate-xml-doc.patch - enable xml doc and export all

Comment 4 Milan Crha 2010-01-06 18:46:04 UTC
I guess some tweaking can be done later, what I trier seemed to be quite good. (Some structures aren't clickable or exported, but that might be also because no documentation is added in them. That the reason why I enabled EXPORT_ALL, because some functions were in xml indexes, but weren't in HTML files, because they are without any documentation.)

Comment 5 Matthew Barnes 2010-01-06 21:49:56 UTC
Oh, nice!  That would definitely be useful.

We probably want to split the developer documentation into an openchange-devel-docs subpackage (cf. gtk2-devel-docs).

I'll take a look at this after I figure out why OpenChange 0.9 isn't building.

Comment 6 Matthew Barnes 2010-01-09 13:45:02 UTC
openchange-devel-docs subpackage added to openchange-0.9-2.fc13.