RFA: Improving StencilEngine Comments

[Jeffrey Oldham]

OK to commit this patch?  Does it meet Pooma comment guidelines?

When working on implementing restriction operators for arrays, I read
through src/Engine/Stencil.h.  The most confusing aspect was that
"domain" is used for both stencil input and stencil output.  Also, the
invariants and data members for the StencilEngine were not documented.
I wrote comments that, I hope, clarify these aspects.

2001-06-29  Jeffrey D. Oldham  <address@hidden>

        * Stencil.h: Fix typographical errors.
        Add stencil concept comments.
        (insetDomain): Modify initial comments.
        (Engine<D,T,StencilEngine>): Fix typographical error.
        (Engine::Engine): Modify initial comments.
        (Engine::read): Likewise.
        (Engine::domain): Likewise.
        (Engine::first): Likewise.
        (Engine::viewDomain): Likewise.  Add other comments.
        (Engine::intersectDomain): Add initial comment.
        (View1): Modify initial comments.
        (View2): Likewise.
        (Stencil): Fix typographical error in initial comments.
        (DataObjectRequest): Likewise.

Tested on       sequential Linux using gcc 3.0 by compiling Pooma library
Approved by     ???you???

Thanks,
Jeffrey D. Oldham
address@hidden

Stencil.h.patch
Description: Text document