Skip to content
This repository has been archived by the owner on Oct 9, 2023. It is now read-only.

Missing documentation #2

Open
dotarmin opened this issue Jan 19, 2018 · 1 comment
Open

Missing documentation #2

dotarmin opened this issue Jan 19, 2018 · 1 comment

Comments

@dotarmin
Copy link
Contributor

Issue originally authored by @Niko-O.

The Svt.Caspar project is completely undocumented. It would be very helpful to have at least some basic documentation of the classes and their members.
I'm talking about the XML-documentation in the code like this:

    /// <summary>
    /// This class is used to do some stuff and it uses <see cref="SomeOtherClass"/> to do that.
    /// </summary>
    public class CasparDevice { ....
@dotarmin
Copy link
Contributor Author

Even if this project is used it's a bit obsolete and should be brought to the surface again. I agree that it lacks documentation but hopefully issue #1 will make it little clearer until real documentation is created.

Best regards,
Armin

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

No branches or pull requests

1 participant