Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unable to get Unity Documentation to Appear in Visual Studio #5

Open
anubhab123 opened this issue Sep 22, 2014 · 10 comments
Open

Unable to get Unity Documentation to Appear in Visual Studio #5

anubhab123 opened this issue Sep 22, 2014 · 10 comments

Comments

@anubhab123
Copy link

I am unable to get the Unity Documentation to appear in Visual Studio. I took the Unity.xml file included in the Hydrogen Framework/Extras/Visual Studio folder and moved it to Program Files/Unity/Editor/Data/Managed and restarted both Unity and Visual Studio but it does not show the documentation as I am typing like it does in the preview screenshots on the hydrogen site.

@reapazor
Copy link
Contributor

I'm going to take a stab at this tonight (haven't forgotten ya! -- though I
have a feeling I should do an update pass on the documentation as well


Matthew Davey
dotBunny

888.632.1993 x700

On Mon, Sep 22, 2014 at 12:52 PM, Anubhav Guha [email protected]
wrote:

I am unable to get the Unity Documentation to appear in Visual Studio. I
took the Unity.xml file included in the Hydrogen Framework/Extras/Visual
Studio folder and moved it to Program Files/Unity/Editor/Data/Managed and
restarted both Unity and Visual Studio but it does not show the
documentation as I am typing like it does in the preview screenshots on the
hydrogen site.


Reply to this email directly or view it on GitHub
#5.

@reapazor
Copy link
Contributor

So I believe I have identified the issue, and its a small change to how IntelliSense works. Each "library" needs to be a seperate file, named identical (except the extension) to the library it represents.

So ...

UnityEngine.xml
and
UnityEditor.xml

Need to be made from the Unity.xml provided, I'm currently looking at updating everything as a whole... just because ... but that should resolve this.

@anubhab123
Copy link
Author

Thanks a lot!

I will contact you soon after trying the fix.

Anubhav
On Oct 14, 2014 9:31 PM, "Matthew Davey" [email protected] wrote:

So I believe I have identified the issue, and its a small change to how
IntelliSense works. Each "library" needs to be a seperate file, named
identical (except the extension) to the library it represents.

So ...

UnityEngine.xml
and
UnityEditor.xml

Need to be made from the Unity.xml provided, I'm currently looking at
updating everything as a whole... just because ... but that should resolve
this.


Reply to this email directly or view it on GitHub
#5 (comment).

@reapazor
Copy link
Contributor

vs-doc-2

So making them separate files does in fact work :) This change will come in a release with Unity 5 more then likely. Unfortunately, I've got a back log of changes for it.

@anubhab123
Copy link
Author

Does Unity.xml need to be there also or only UnityEditor.xml and
UnityEngine.xml?

On Thu, Oct 16, 2014 at 8:59 AM, Matthew Davey [email protected]
wrote:

Closed #5 #5.


Reply to this email directly or view it on GitHub
#5 (comment).

@reapazor
Copy link
Contributor

One for each library, so UnityEngine.xml and UnityEditor.xml ... Just make
sure to edit the files to contain only the relevant info.

I will push an update when Unity 5 is available to the public with updated
files and instructions.

On Friday, October 17, 2014, Anubhav Guha [email protected] wrote:

Does Unity.xml need to be there also or only UnityEditor.xml and
UnityEngine.xml?

On Thu, Oct 16, 2014 at 8:59 AM, Matthew Davey <[email protected]
javascript:_e(%7B%7D,'cvml','[email protected]');>
wrote:

Closed #5 #5.


Reply to this email directly or view it on GitHub
#5 (comment).


Reply to this email directly or view it on GitHub
#5 (comment).


Matthew Davey
dotBunny

888.632.1993 x700

@anubhab123
Copy link
Author

hey i was wondering what info should or should not be contained in each
file. Is it just references to untiyengine name tags or?

On Fri, Oct 17, 2014 at 11:38 PM, Matthew Davey [email protected]
wrote:

One for each library, so UnityEngine.xml and UnityEditor.xml ... Just make
sure to edit the files to contain only the relevant info.

I will push an update when Unity 5 is available to the public with updated
files and instructions.

On Friday, October 17, 2014, Anubhav Guha [email protected]
wrote:

Does Unity.xml need to be there also or only UnityEditor.xml and
UnityEngine.xml?

On Thu, Oct 16, 2014 at 8:59 AM, Matthew Davey <[email protected]
javascript:_e(%7B%7D,'cvml','[email protected]');>
wrote:

Closed #5 #5.


Reply to this email directly or view it on GitHub
#5 (comment).


Reply to this email directly or view it on GitHub
#5 (comment).


Matthew Davey
dotBunny

888.632.1993 x700


Reply to this email directly or view it on GitHub
#5 (comment).

@reapazor
Copy link
Contributor

Everything for the UnityEngine needs to be in there, and then everything for the UnityEditor needs to be in its respective file.

I dont think I understand what your asking :(

@reapazor reapazor reopened this Nov 10, 2014
@anubhab123
Copy link
Author

Hey so looking in the included Unity.xml file I see xml tags with methods
of various namespaces(UnityEngine and UnityEditor). e.g.

or

    <member name="M:UnityEngine.ADBannerView.Finalize">
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
    </member>

I took all the M:UnityEngine tags and added them to UnityEngine.xml and all
the M:UnityEditor tags and put them in UnityEditor.xml and put them in
the C:\Program Files (x86)\Unity\Editor\Data\Managed. I also restarted
Visual Studio and rebuilt and also deleted references to UnityEngine and
UnityEditor and added the dlls in C:\Program Files
(x86)\Unity\Editor\Data\Managed. Originally they were in some Assemblies
folder.

I don't know if maybe I have a path misset or if instead I should put the
.xml files in the assemblies folder but I can't seem to get it to work.

Thank you very much for your help and let me know if you're still confused.

Anubhav

On Sun, Nov 9, 2014 at 9:29 PM, Matthew Davey [email protected]
wrote:

Reopened #5 #5.


Reply to this email directly or view it on GitHub
#5 (comment).

@anubhab123
Copy link
Author

let me know if you need more information or clarification. I'd be happy to
give more detailed explanation.

On Tue, Nov 11, 2014 at 12:31 PM, Anubhav Guha [email protected] wrote:

Hey so looking in the included Unity.xml file I see xml tags with methods
of various namespaces(UnityEngine and UnityEditor). e.g.

or

    <member name="M:UnityEngine.ADBannerView.Finalize">
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
    </member>

I took all the M:UnityEngine tags and added them to UnityEngine.xml and
all the M:UnityEditor tags and put them in UnityEditor.xml and put them in
the C:\Program Files (x86)\Unity\Editor\Data\Managed. I also restarted
Visual Studio and rebuilt and also deleted references to UnityEngine and
UnityEditor and added the dlls in C:\Program Files
(x86)\Unity\Editor\Data\Managed. Originally they were in some Assemblies
folder.

I don't know if maybe I have a path misset or if instead I should put the
.xml files in the assemblies folder but I can't seem to get it to work.

Thank you very much for your help and let me know if you're still confused.

Anubhav

On Sun, Nov 9, 2014 at 9:29 PM, Matthew Davey [email protected]
wrote:

Reopened #5 #5.


Reply to this email directly or view it on GitHub
#5 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants