IDE Documentation

From Unify Community Wiki
(Difference between revisions)
Jump to: navigation, search
m (Added link to the install instructions.)
 
(10 intermediate revisions by 6 users not shown)
Line 1: Line 1:
== IDE Documentation==
+
== Hydrogen Frame ==
With the release of Unity 2.6, we now have a nice way of syncing to Visual Studio projects. This opens the door to some nice IntelliSense for both MonoDevelop and Visual Studio. What is still missing from the picture, is some inline documentation to go with it. That is the void, to which these packages fill. Currently only C# is supported, I'll make sure to come up with something when UnityScript comes to MonoDevelop/VisualStudio.
+
With over 53,000 downloads of the MonoDevelop.Unity, we have decided to inject some life back into it, and have added it recently updated and added it to our [http://hydrogen.dotbunny.com/getting-started/#included Hydrogen Framework]. Contained within the packages 'Extras' folder you will find the necessary files (XML Documentation) to provide IntelliSense for many IDEs.
  
If anyone has any suggestions which are feasible (meaning the app has to have a method for inline docs), let me know (Reapazor) and I'll see about generating files for it.  Or if Unity Technologies would be so kind as to give me some access I would love to make the official docs.
+
Please [http://hydrogen.dotbunny.com/getting-started/#cld refer to the website] for install instructions for different IDEs.
 
+
======MonoDevelop Screenshot======
+
[[Image:documentation-monodevelop.png]]
+
 
+
======Visual Studio Screenshot======
+
[[Image:documentation-vs.png]]
+
 
+
 
+
It's in the works, but a stripped down version of MonoDevelop.Unity will get installed into MonoDevelop to add shortcuts to get to the Unity documentation.
+
 
+
==== Mac ====
+
=====Supports: MonoDevelop=====
+
As people do not like running "random" installers, I will tell you ALL that this installer does is move the compiled MonoDoc sources into the MonoDoc sources folder (located under /Library/Frameworks/Mono.framework/....). It also installs a small addin into MonoDevelop which allows you to search to documentation of Unity. (Key Bindings are under MD's own Key Binding Settings)
+
 
+
[http://download.dotbunny.com/unity/documentation/mac/monodevelop-2.6.0f7-003.zip Mac Download] v003
+
 
+
==== Windows ====
+
===== Supports: MonoDevelop, Visual Studio (2005,2008,2010) =====
+
 
+
This installer copies the MonoDoc sources into the sources folder, located under the Program Files\MonoDevelop folder, as well as puts the VS XML files into the Unity\Editor\Data\lib\ folder.
+
 
+
There is no addin installed on the windows version (yet! - desktop called it quits for a bit ;/), I did a quick test and it wasnt working on windows, but it will get fixed shortly (it worked before).
+
 
+
[http://download.dotbunny.com/unity/documentation/win/monodevelop-vs-2.6.0f7-001.msi Win Download]
+

Latest revision as of 03:30, 8 December 2013

[edit] Hydrogen Frame

With over 53,000 downloads of the MonoDevelop.Unity, we have decided to inject some life back into it, and have added it recently updated and added it to our Hydrogen Framework. Contained within the packages 'Extras' folder you will find the necessary files (XML Documentation) to provide IntelliSense for many IDEs.

Please refer to the website for install instructions for different IDEs.

Personal tools
Namespaces

Variants
Actions
Navigation
Extras
Toolbox