Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
flesh out the docs a bit
  • Loading branch information
Stevan Little committed Feb 3, 2013
1 parent 9105f45 commit 62cb137
Showing 1 changed file with 54 additions and 1 deletion.
55 changes: 54 additions & 1 deletion src/main/scala/org/moe/runtime/README.md
Expand Up @@ -14,4 +14,57 @@ host runtime.

## MoeRuntime

This is the main runtime object, it
This is the main runtime class, it takes an instance of MoeSystem
as a parameter. The `bootstrap` method must be called before anything
useful can be done with this.

## MoeEnvironment

This represents a lexical environment.

## MoeErrors

This is a set of exceptions that can be used within Moe

## MoeObject

This represents an object which may or may not have an associated
class, and has a numeric ID associated with it.

## MoeOpaque

This is a subclass of MoeObject and adds the ability to store
instance values.

## MoeNativeObject

This is a base class and several implementations for the native
objects that Moe supports.

## MoePackage

This represents a package in Moe. Packages can contain subroutines,
classes and sub-packages (all in seperate namespaces (at least for
now they are, this might change)). Packages are also aware of thier
parent packages. Packages also have an associated MoeEnvironment
instance which is the environment the package was compiled with (
this is useful for closures, etc.)

### MoeSubroutine

This represents a subroutine in Moe.

## MoeClass

This represents a class in Moe. Classes have associated attributes
and methods, and may or may not have an associated superclass.

### MoeAttribute

This represents a class attribute in Moe.

### MoeMethod

This represents a class method in Moe.


0 comments on commit 62cb137

Please sign in to comment.