Blog: LPub4 for Linux, 2nd iteration: lpub4-dev-doc-fixes.patch

File lpub4-dev-doc-fixes.patch, 3.6 KB (added by retracile, 15 years ago)

  • lpub.h

    old new  
    4747 *    paths(h,cpp) - a place to put the names of external dependencies like
    4848 *      the path for the LDraw file system, the path to ldglite, etc.
    4949 *
    50  *    render(h,cpp) - provides access to the renderer which currently only
    51  *      means ldglite.  LDView is the only other canidate renderer under
    52  *      consideration.
     50 *    render(h,cpp) - provides access to the renderer, either ldglite or
     51 *      LDView.
    5352 *
    5453 *  The next layer has to do with the parsing of the LDraw files and knowing
    5554 *  what to do with them.  At the lowest level, LPub's parsing is line based
    … …  
    110109 *
    111110 *   The cornerstone of this page oriented process is line by line parsing
    112111 *   and recognition of the lines in your ldraw file.  There are two functions
    113  *   that do this parsing.  findPage traverses the model higherarchy, counting
    114  *   pages.  One issue is that you do not know the page number at start of
    115  *   step, because non-callout submodels result in pages.  findPage is lightweight
     112 *   that do this parsing.  findPage traverses the model hierarchy, counting
     113 *   pages.  One issue is that you do not know the page number at the start of
     114 *   a step, because non-callout submodels result in pages.  findPage is a lightweight
    116115 *   mechanism for scanning through the design, and finding the page of interest.
    117116 *   at each page boundary, if the current page number is not the desired page
    118117 *   and the current page is before the desired page, the state of the parse is
    … …  
    192191 *   drawPage (not the detailed one findPage calls, but a highlevel one
    193192 *   that takes no parameters.  Draw page converts the LDraw file structure
    194193 *   tree (ranges, range, step) and the configuration tree (Meta) into
    195  *   graphical entities. drawPage is a member of LPub (therefore lpub.h,
     194 *   graphical entities. drawPage is a member of LPub (therefore lpub.h),
    196195 *   and implemented in traverse.cpp.
    197196 *
    198197 *   The LDraw structure tree is composed of classes including:
    … …  
    280279 *   placementdialog lets the user access LPub's placement concept of
    281280 *   things placed relative to things with margins in between.
    282281 *
    283  *   The can also use the mouse to drag things around on the page, to change
     282 *   The user can also use the mouse to drag things around on the page, to change
    284283 *   placement.  The implementations of these movements and their backannotation
    285284 *   into the ldraw files are implemented in *item.cpp
    286285 *
    … …  
    319318 *   in conjuction with the undo redo facility.  These commands are
    320319 *   implemented in commands.(h,cpp).
    321320 *
    322  *   This leaves only a few miscellanous files unexplained.  commonmenis.(h,cpp)
     321 *   This leaves only a few miscellanous files unexplained.  commonmenus.(h,cpp)
    323322 *   could just as easily been named metamenus.(h.cpp).  These implement
    324323 *   popup menu elements (and their help information) for commonly used
    325324 *   meta commands.

  • meta.cpp

    old new  
    2121 * all the meta-commands that LPub supports.  Action metas such as STEP,
    2222 * ROTSTEP, CALLOUT BEGIN, etc. return special return codes.  Configuration
    2323 * metas that imply no action, but specify data for later use, retain
    24  * the onfiguration information, and return a generic OK return code.
     24 * the configuration information, and return a generic OK return code.
    2525 *
    2626 * The top of tree is the Meta class that is the interface to the traverse
    2727 * function that walks the LDraw model higherarchy.  Meta also tracks