DotNet Documentation available?

[Karamaoynas Polykarpos]

Is there any full documentation for EyeX SDK for dotNet?
The file “Developer’s Guide DotNet.pdf” contains only introductory information.
For example what does EngineState.DisplaySize mean?
What’s the functionality of EyeXHost methods?

[Anders]

Hi Polykarpos,
there is plenty of so-called “slashdoc” documentation in the source code for the EyeX Framework for .NET. All the methods and all enum values should be documented in a format that is directly available through IntelliSense. For example:

        /// <summary>
        /// Gets the engine state: Display size, width and height, in millimeters.
        /// </summary>
        public static EngineState<Size2> DisplaySize
        {
            get { return new EngineState<Size2>(StatePaths.DisplaySize); }
        }

I hope you will be able to find the information you are looking for there.

We have also considered generating an API reference based on this information but it hasn’t been given high enough priority yet. Please let us know if that would be helpful.

[Karamaoynas Polykarpos]

Thank you Anders. This will be helpful

PK

[Author]

Posts