Bug 3112 - Add support for MonoDoc browser to show MonoMac docs
Summary: Add support for MonoDoc browser to show MonoMac docs
Status: RESOLVED ANSWERED
Alias: None
Product: MonoMac
Classification: Desktop
Component: Bindings ()
Version: unspecified
Hardware: Macintosh Mac OS
: --- normal
Target Milestone: ---
Assignee: Jérémie Laval
URL:
Depends on:
Blocks:
 
Reported: 2012-01-27 11:09 UTC by Matthias Fuchs
Modified: 2015-02-18 14:59 UTC (History)
3 users (show)

Tags:
Is this bug a regression?: ---
Last known good build:

Notice (2018-05-24): bugzilla.xamarin.com is now in read-only mode.

Please join us on Visual Studio Developer Community and in the Xamarin and Mono organizations on GitHub to continue tracking issues. Bugzilla will remain available for reference in read-only mode. We will continue to work on open Bugzilla bugs, copy them to the new locations as needed for follow-up, and add the new items under Related Links.

Our sincere thanks to everyone who has contributed on this bug tracker over the years. Thanks also for your understanding as we make these adjustments and improvements for the future.


Please create a new report on Developer Community or GitHub with your current version information, steps to reproduce, and relevant error messages or log files if you are hitting an issue that looks similar to this resolved bug and you do not yet see a matching new report.

Related Links:
Status:
RESOLVED ANSWERED

Description Matthias Fuchs 2012-01-27 11:09:27 UTC
Many methods don't have the same name as their objective-c counterparts. That's ok, because most of the objective-c names are much to long and unreadable.

But nonetheless it would be easier, to have a link or simply the name of the corresponding method declaraion in the inline docs provides by MonoDevelop.

So it would be easier to match "public override void Resize(NSSplitView splitView, SizeF oldSize)" to "splitView:resizeSubviewsWithOldSize:".

This is needed to be able to dig into the Apple Dev Docs. Unfortunately, most or even all Methods, Properties etc in the MonoMac assembly don't have docs attached.

That's pretty bad, especially if you're new to Cocoa programming!
MonoMac should make programming with cocoa easier but unfortunately sometimes it's way harder ...
Comment 1 Miguel de Icaza [MSFT] 2012-02-21 12:43:50 UTC
In general, our API documentation shows this and we even have a tool that will blend your Apple docs with the Monomac docs.
Comment 2 Miguel de Icaza [MSFT] 2012-02-21 12:47:43 UTC
We need to do a few things for this:

(a) We need to make it so that MonoDoc browser can load MonoMac docs that would come from within the MonoDevelop internal directory (not the /Library/Frameworks/...)

(b) We need to make it so that we can run the "docfixer" tool on first use to merge Apple docs with our reference XML files.
Comment 3 Mikayla Hutchinson [MSFT] 2012-02-21 14:11:41 UTC
and
(c) bundle MonoMac docs with the MonoMac addin

Re. (a), MD already passes internally-registered docs paths to monodoc.dll and MonoDoc.app, we just need to check that the new MonoMac.app can handle it.
Comment 4 Timothy Risi 2015-02-18 14:59:15 UTC
MonoMac documentation is now viewable in MonoDoc.  We're still working on getting everything completely documented.  In the meantime, http://developer.xamarin.com/guides/mac/ has some helpful tips and information for finding the method you're looking for based on the obj-c selector.  If you have additional documentation suggestions/requests, you can post them at http://forums.xamarin.com/discussion/28582/new-xamarin-mac-documentation-live#latest