Quantcast
Channel: JavaScriptMVC Forum
Viewing all articles
Browse latest Browse all 3491

DocumentJs generates no documentation

$
0
0
Hi
I have a problem using DocumentJS.
First of all my project structure:

Inventory/assets/www/ <--- root folder
  • documentJS
  • funcunit
  • inventory <-- project folder
    • application <-- MVC files
      • model
      • view
      • controller
      • fixtures
    • css
    • img
    • js <-- general js helper files
    • index.html
    • inventory.js  <-- main js file, comments starts with @page index inventory
  • jquery
  • jqueryMobile
  • steal
I try to make a documentation of my development code (had problems by generation production.js as well)
Unfortunately i just get an docs.html in my project folder and in a new docs folder a searchData.json file.

If I'm open the dos.html file it is unstyled and just shows a message "loading"

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"
    "http://www.w3.org/TR/html4/strict.dtd">
    <html lang="en">
        <head>
            <title>
                JavaScriptMVC
            </title>
            <link rel="shortcut icon" href="../../../../../../../../../documentjs/jmvcdoc/images/favicon.ico">
        </head>
        <body>
            <div id='documentation'>
                <div id='top'>
                    <div class="content">
                        <div id="searchRoundCorners">
                            <input id='search' type='input' disabled='true'>
                        </div>
                        <div id='defaults'>
                            <ul id="menu" class="ui-menu">
                                <li class="ui-menu-item">
                                    <a class="menuLink" href="#&amp;search=*&amp;who=index"><span class="menuSpan">Home</span></a>
                                </li>
                                <li class="ui-menu-item">
                                    <a class="menuLink" href="#favorites"><span class="menuSpan">Favorites</span></a>
                                </li>
                                <li class="ui-menu-item">
                                    <a class="menuLink" href="http://javascriptmvc.com/#&amp;who=follow" title="Follow"><span class="menuSpan red">Follow</span></a>
                                </li>
                                <li class="ui-menu-item">
                                    <a class="menuLink" href="#&amp;who=contribute" title="Contribute"><span class="menuSpan red">Contribute</span></a>
                                </li>
                                <li class="ui-menu-item">
                                    <a class="menuLink" href="#&amp;who=code" title="Code"><span class="menuSpan red">Code</span></a>
                                </li>
                            </ul>
                        </div>
                        <div class="logo-text">
                            <a href='http://javascriptmvc.com'><img src='../documentjs/jmvcdoc/images/logo80x30.png' class="logo-image"></a>
                        </div>
                    </div>
                </div>
                <div id='bottom'>
                    <div id='nav'>
                        <a>Loading ...</a>
                    </div>
                    <div id='doc_container'>
                        <div id='doc'>
                            Add a page named 'index' to see something here.
                        </div>
                        <div id="disqus_thread"></div>
                    </div>
                </div>
            </div>
            <div id='low'>
                <a href="http://jupiterit.com">© Jupiter Consulting - JavaScriptMVC Training and Support</a>
            </div><script type='text/javascript'>
    DOCS_LOCATION = "docs/" //adds searchData to this
            </script><script type='text/javascript' src='../../../../../../../../../steal/steal.production.js?documentjs/jmvcdoc'>
    </script>
        </body>
    </html>

Maybe theres a path problem.
When I start the doc.bat i have to use the full path to my project folder instead of the name
..../Inventory/assets/www/documentjs/doc.bat ..../Inventory/assets/www/inventory

the script loops over all js files inside my project folder and print out following message

 GENERATING DOCS -> ..../Inventory/assets/www/inventory
/docs

Using default page layout.  Overwrite by creating: ..../Inventory/assets/www/inventory/summary.ejs
There is no summary.ejs file in my root folder.


Do somebody have an idea?

PS: I use version 3.2.4 of JMVC


Viewing all articles
Browse latest Browse all 3491

Trending Articles