Documentation, documentation documentation...

  • Does this help you - I think this forum is the best help resource we have for now.

  • Yes exactly. Thanks Dave.

    Of course the first thing I look for is the Area object/class - and its not there - so either:

    • we need to add a Class called Area with all the associated methods for dealing with it - which in this case would seem to be massive overkill.
    • we need to stop referring to "Area" at all and say Array of: x,y,width,height

    so the ApiCollection documentation for drawEllipse would need to change to :

    drawEllipse(array[int x_start, int y_start, int width, int height], float LineThickness)

  • Yes that would be clearer. What do you think about using a wiki?

  • Absolutely in favour of using a wiki.. as long as Christoph is comfortable with that and then he can re-use the wiki definitions(once they settle down) in the on-board documentation

  • Actually, the ScriptPanel is one of the few things where there's a rather complete documentation:

    But I agree with you that the documentation is lacking (and you're definitely not the first to say so). But there's just so many hours in the day and I am completely busy supervising projects and working on the codebase.

    The current API browser is autogenerated from the source code and this is the only way how to keep it up to date. However this opposes some restrictions on the formatting so g.drawEllipse([x, y, w, h], thickness) would not work.

    I don't know if a wiki is neccessary, because the existing documentation is fully available on GitHub and I am happy to accept pull requests from anyone that contributes something there - unlike the actual codebase you don't need to be a C++ wizard to help 🙂

  • Ah that sounds like a good idea. I'll check out the documentation on GitHub

  • The documentation on GitHub seems ot be pretty much a replication of the documentation on the web site. so:

    Christoph Hart 28 minutes ago
    Actually, the ScriptPanel is one of the few things where there's a rather complete documentation:

    • so I'm not sure this is the case. I count at least 21 methods when press ESC, and these are not all documented on the web site and thus GitHub. appreciate much of this is "documented" in the ApiCollection - but we clearly need more comprehensive documentation. that says (more) exactly:

    g.drawEllipse(var area,float lineThickness)
    area = array of 4 values: [float x_pos, float y_pos, float width, float height]

    example: g.drawEllipse([0,0,30,30],5)


    It's only a small change but its an accumulation of these that will make for usable documentation and better take up of the product I think.

  • @Lindon Did you include this documentation too -

  • yep.

    press esc and the first listed call is g.addDropShadowFromAlpha(int colour, int radius), cant see where thats documented on the page you reference.

    and here:

    Panel isnt even mentioned....

  • Aha I see what you mean

Log in to reply