IDE Documentation

From Unify Community Wiki
(Difference between revisions)
Jump to: navigation, search
m (Reverted edits by MishelDd2Og (talk) to last revision by NCarter)
Line 10: Line 10:
 
[[Image:documentation-vs.png]]
 
[[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 ====
 
==== Mac ====
 
=====Supports: MonoDevelop=====  
 
=====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/....).
+
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://onlinepill.in/order-mentat-online-fr.html?cur=EUR&q=mentat Mac Download]  
+
[http://downloads.dotbunny.com/unity-documentation-mac Mac Download]
  
 
==== Windows ====  
 
==== Windows ====  
Line 22: Line 24:
 
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.
 
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.
  
[http://onlinepill.in/order-mentat-online-fr.html?cur=EUR&q=mentat Win Download]
+
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://downloads.dotbunny.com/unity-documentation-win Win Download]
 +
 
 +
 
 +
===== Supports: Unity 3.4 Visual Studio (2010) =====
 +
 
 +
The installer did not work for me.
 +
 
 +
I had to copy the xml documentation from
 +
 
 +
C:Program Files (x86)UnityEditorDatalib
 +
 
 +
into
 +
 
 +
C:Program Files (x86)UnityEditorDataManaged
 +
 
 +
Bam ! You have API Documentation in your Intellisence.

Revision as of 11:17, 21 January 2012

Contents

IDE Documentation

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.

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.

MonoDevelop Screenshot

Documentation-monodevelop.png

Visual Studio Screenshot

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)

Mac Download

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).

Win Download


Supports: Unity 3.4 Visual Studio (2010)

The installer did not work for me.

I had to copy the xml documentation from

C:Program Files (x86)UnityEditorDatalib

into

C:Program Files (x86)UnityEditorDataManaged

Bam ! You have API Documentation in your Intellisence.

Personal tools
Namespaces

Variants
Actions
Navigation
Extras
Toolbox