Search Unity

  1. Welcome to the Unity Forums! Please take the time to read our Code of Conduct to familiarize yourself with the forum rules and how to post constructively.
  2. Unite 2023 Registrations are now LIVE! We are thrilled to announce that Unite 2023 Registration is now live and open for all!
    Dismiss Notice
New Forum User Notice Unite 2023 Registrations are now LIVE!

Interface-documentation (like IPointerDownHandler) not findable

Discussion in 'Documentation' started by TanteDante, Jan 21, 2015.

  1. TanteDante

    TanteDante

    Joined:
    Oct 28, 2014
    Posts:
    6
    Hi
    it seems to me, that the documentation of Interfaces isn't the best.
    I watched a tutorial, where the interfaces IPointerDownHandler and IPointerEnterHandler were used and I tried to find the documentation to those. I can search for them and find some documentation (like http://docs.unity3d.com/460/Documentation/ScriptReference/EventSystems.IPointerEnterHandler.html),
    but if I want to look, which Interfaces the namespace UnityEngine.EventSystems has, I can't look it up.
    Classes and Enumerations are accessible through the document tree on the left side, but not the interfaces.
    I wanted to ask, why is it so?

    Sorry for my bad english, it's not my motherlanguage.
     
    TanteDante, Jan 21, 2015
    #1

  2. Graham-Dunnett

    Graham-Dunnett

    Unity Technologies

    Joined:
    Jun 2, 2009
    Posts:
    4,287
    It's because the docs haven't been written. :-( Work is underway to make the 5.0 docs as good as possible. Whether the EventSystems pages will get seen to or not I am not sure at this time.
     
    Graham-Dunnett, Jan 23, 2015
    #2

  3. hexagonius

    hexagonius

    Joined:
    Mar 26, 2013
    Posts:
    98
    I just came across this post while trying to understand how IPointerExitHandler is supposed to work. Will the docs be improved any further in the future? information like "Called by a BaseInputModule when an OnPointerExit event occurs" leads to the question when that might be, which the BaseInputModel doesn't explain really.
     
    hexagonius, Feb 1, 2016
    #3

  4. duck

    duck

    Unity Technologies

    Joined:
    Oct 21, 2008
    Posts:
    358
    Yes, they will be improved. We are aiming to have a big push on improving all the Script Reference pages with very short descriptions. This is a Big Job™ (there are about ten thousand scriptref pages) and will be aided by new hires in our docs team this year!
     
    duck, Feb 2, 2016
    #4

  5. hexagonius

    hexagonius

    Joined:
    Mar 26, 2013
    Posts:
    98
    Thanks for the update, that's very cool to hear
     
    hexagonius, Feb 2, 2016
    #5