Ticket #297 (new defect)
Documentation comment style causes many page load errors and page fails to load
| Reported by: | ron.alexander | Owned by: | somebody |
|---|---|---|---|
| Priority: | normal | Milestone: | 2.0.x-next-patch |
| Version: | 2.0.304 | Severity: | normal |
| Keywords: | documentation | Cc: |
Description
DESCRIPTION: The documentation .htm and .js files currently includes a commented out license boilerplate. The comments are all ColdFusion? style comments lt bang dash dash dash and for the .htm files should be lt bang dash dash and slash star star for the .js files. Comment closings also need to be fixed, see Proposed Solution below for fix.
OS: MS Windows XP Browser: Firefox 1.5.012 and IE6
BEHAVIOR: Loading the documentation in a browser window hangs indefinitely (over a minute anyways) and the javascript console reports many errors in very close succession.
This is a repeatable bug across more than one browser and is not intermittent.
STEPS TO DUPLICATE: 1. Download MGUnity from http://www.model-glue.com/downloads/modelglue_2.0.304.zip 2. Unzip and follow installation instructions for install with mappings 3. Open documentation index.html 4. Open javascript console to see errors
PROPOSED SOLUTION: 1. Do a find and replace on all .htm files in the documentation root folder.
Find: lt bang dash dash dash Replace With: lt bang dash dash
2. Do a find and replace on all .htm files in the documentation root folder.
Find: dash dash dash gt Replace With: dash dash gt
3. Do a find and replace on all .js files in the documentation root folder
Find: lt bang dash dash dash Replace With: slash star star
4. Do a find and replace on all .js files in the documentation root folder
Find: dash dash dash gt Replace With: star star slash
LEGEND: lt = < gt = > bang = ! slash = / star = *
![(please configure the [header_logo] section in trac.ini)](/ModelGlue.com/trac.cgi/chrome/site/your_project_logo.png)