racket/collects/scribblings/gui/point-class.scrbl
Eli Barzilay 264af9a6d0 improved scribble syntax use
svn: r8720
2008-02-19 12:22:45 +00:00

42 lines
653 B
Racket

#lang scribble/doc
@(require "common.ss")
@defclass/title[point% object% ()]{
A @scheme[point%] is used for certain drawing commands. It
encapsulates two real numbers.
@defconstructor*/make[(()
([x real?]
[y real?]))]{
Creates a point. If @scheme[x] and @scheme[y] are not supplied, they
are set to @scheme[0].
}
@defmethod[(get-x)
real?]{
Gets the point x-value.
}
@defmethod[(get-y)
real?]{
Gets the point y-value.
}
@defmethod[(set-x [x real?])
void?]{
Sets the point x-value.
}
@defmethod[(set-y [y real?])
void?]{
Sets the point y-value.
}}