ASDoc: Top Level Package

Hi folks,
after searching around quite a while without success I am
wondering if you could help me with a question.
We have documented our code and used the "-package" parameter
with asdoc for our package description. However, how can we add the
description of the Top Level package into ASDoc? With the
"-package" parameter I can only address "real" packages, but not
the Top Level package.
Thanks for your help!
Regards
Michael

Hi folks,
after searching around quite a while without success I am
wondering if you could help me with a question.
We have documented our code and used the "-package" parameter
with asdoc for our package description. However, how can we add the
description of the Top Level package into ASDoc? With the
"-package" parameter I can only address "real" packages, but not
the Top Level package.
Thanks for your help!
Regards
Michael

Similar Messages

  • Multiple top level package declarations

    The "Programming Adobe ActionScript 3.0" states in chapter 4 "ActionScript Language and Syntax", "Packages and Namespaces", "Creating Packages" that you can declare at the top level of a package multiple variables, functions, and namespaces in addition to a single class as long as only one is declared "public".
    However, in Flash when I declare a public class and any other variable or function either with the "internal" attribute or no attribute, I get this error:
    5006: An ActionScript file can not have more than one externally visible definition: test.function1, test.Test
    The package code is as follows:
    package test
        internal function function1():String
            return "Function1()";
        public class Test
    The same thing happens if I replace the function with an internal variable declaration. According to the manual, any declaration with the "internal" attribute should not be externally visible outside the package. Only the "public" class declaration should be externally visible.
    Can anyone clue me in as to why I get this error?

    That is not the situation described by the quoted manual section that I am trying to recreate.
    It clearly says:
    "In ActionScript 3.0, you use the package statement to declare a package, which means that you can also declare variables, functions, and namespaces at the top level of a package. You can even include executable statements at the top level of a package. If you do declare variables, functions, or namespaces at the top level of a package, the only attributes available at that level are public and internal, and only one package-level declaration per file can use the public attribute, whether that declaration is a class, variable, function, or namespace."
    The data properties and class you have decleared are outside the package within the ActionScript file, and not at the top level of a package. The "public" attribute is not available outside the package at all.
    What I wish to know is why the quoted internal declarations at the top level of the package generate the quoted error.
    However, I am beginning to believe that the documentation is in error and that what it is actually describing IS the situation you just described. When the manual says "top level of the package", it really means "top level of the ActionScript file outside the package", and when it says "the only attributes available at that level are public and internal", it really mans "the only attribute available outside the package declaration is internal. At the top level of the package, only one declaration may be made, it must have the same identifier as the ActionScript file name, and it can have either the public or internal attribute. Code within the same file but outside the package declaration can not access an internal declaration in the package declaration."
    Actually, the whole paragraph would need to be re-written to clarify the issue and to unambiguously distinguish between "top level of a package" and "top level of an ActionScript file outside the package declaration".
    As a concrete example - two ActionScript files:
    MCTest.as is saved in the same directory as MCTest.fla, and the document class of MCTest.fla is set to "MCTest".
    package
        trace("MCTest package code.");
        import flash.display.MovieClip;
        import test.Test;
        public class MCTest
        extends MovieClip
            trace("MCTest class code.");
            function MCTest()
                trace("Created Class MCTest: " + Test.StaticMessage);
    trace("MCTest outside package code");
    Test.as is saved in a sub-directory called "test".
    package test
        trace("test.Test package code");
        public class Test
            public static const StaticMessage:String = "Test: Hello World!";
            trace("test.Test class code");
    var myField:String = "myField";
    function myFunction():String
        return "myFunction";
    trace("test.Test outside package: " + myField + ", " + myFunction() + ", " + test.Test.StaticMessage);
    The resultant trace output is:
    MCTest class code.
    MCTest package code.
    MCTest outside package code
    test.Test class code
    test.Test package code
    test.Test outside package: myField, myFunction, Test: Hello World!
    Created Class MCTest: Test: Hello World!
    It is interesting to note that the package and outside package code are executed AFTER the class code.
    That seems to make more sense. You can only declare one class, variable, function, or namespace at the top level of a package with the same identifier as the file name, public or internal, and you can include executable code. At the top level of the ActionScript file outside the package declaration, you can only declare internal classes, variables, functions, and namespaces, and you can include executable code, none of which are within the package nor have access to any package internal declarations.
    The problem, therefore, would seem to be an incorrect manual. Does anyone actually know if this is accurate and the intended behavior?

  • Failed to load XML from the package file "" due to error 0xC00CE556 "Invalid at the top level of the document.Line.

    Using Installation wizard to deploy SSIS packages from DEV server to QA server package store cause this error;
    Failed to load XML from the package file "" due to error 0xC00CE556 "Invalid at the top level of the document. Line 773, Column 93". This happens when loading a package and the file cannot be opened or loaded correctly into XML document.  This can be the
    result of either providing an incorrect file name to the LoadPackage method or the XML file specified having an incorrect format.  Please who have the idea of how this issue can be resolved?BI Developer

    Hi ,
       for this Error one and only one solution 
    go to view Code, line number and Column number shown in error message,
    and Remove code from there till last and save it,  it happens when we are moving Package from one server to another server. and VS adds some lines of code at the bottom of package
    something like this 
    andles="1" allownudging="1" isannotation="0" dontautolayout="0" groupcollapsed="0" tabstop="1" visible="1" snaptogrid="0">
        <control>
          <ddsxmlobjectstreaminitwrapper binary="00080000921400008c040000" />
        </control>
        <layoutobject>
          <ddsxmlobj>
            <property name="LogicalObject" value="{BBFB0E
    Remove this code and save package it will work.  
    hope this will help to Developers who are searching for same ......... :) 

  • XML document must have a top level element. Error processing resource

    Hi,
    I am trying to send a XML file to a web browser from a servlet. I read the contents of the XML file into a string and I am sending it to the brower. Before I do this I set the 'Content-type' header of the httpResponse to "application/xml" . Embedded in the XML file is an xml-stylesheet elemetn indicating which *.xsl stylesheet to use to parse the XML content.
    I get the following error:
    The XML page cannot be displayed
    Cannot view XML input using XSL style sheet. Please correct the error and then click the Refresh button, or try again later.
    XML document must have a top level element. Error processing resource 'http://127.0.0.1:8080/testReplyingXML/xml-to-html.xs...
    Now, if I take the stylesheet element out of the XML string I sent, then the browser stores the content into and *.xml file. I manually run the "xml-to-xsl " stylesheet mentioned in the error output above, and there is no problem, the xml content gets successfully transformed in a viewable HTML .
    It is only when I embed the "stylesheet" element into the XML content that I get this error.
    So the browser is receiveing valid XML.
    I am not sure if the above error is complaining about the XML content I send or the stylesshet .
    Does anyone have an idea of what am I doing wrong?
    For your information here are my servlet code and the XML file:
    servlet:-
    package webapps.testReplyingXML;
    import java.io.BufferedReader;
    import java.io.IOException;
    import javax.servlet.ServletException;
    import javax.servlet.http.HttpServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import java.io.FileReader;
    import java.util.Enumeration;
    import java.util.StringTokenizer;
    import java.io.PrintWriter;
    public class ReplyXML extends HttpServlet {
              static int transactionCount = 0;
              public void doGet(HttpServletRequest req, HttpServletResponse res) throws ServletException ,IOException {
                   String Q_PARAM = "query";
                   String requestString = req.getQueryString();
                   for ( Enumeration en = req.getParameterNames() ; en.hasMoreElements() ; )
         String k = (String)en.nextElement() ;
         String[] x = req.getParameterValues(k) ;
         String s = null;
         String DATA_PARAM= "";
         for(int i = 0 ; i < x.length ; i++ )
         s = x[i] ;
         //System.out.println("s = " + s);
         if (k.equals("query")){
              try {
                             //res.setHeader("Content-Type", "application/xml");
                             //res.setHeader("Transfer-Encoding", "chunked");
                             //res.setHeader("Cache-Control", "no-cache");
                             //res.setHeader("Server", "Jetty/5.1.10");
                             //res.setHeader("Pragma", "no-cache");
                             //res.setHeader("X-Joseki-Server", "Joseki-3.0-dev");
                             res.setStatus(res.SC_OK);
                             StringBuffer fileData = new StringBuffer(1000);
                        BufferedReader reader = new BufferedReader(new FileReader("sparql_results.xml"));
                        char[] buf = new char[1024];
                        int numRead=0;
                        while((numRead=reader.read(buf)) != -1){
                        String readData = String.valueOf(buf, 0, numRead);
                        fileData.append(readData);
                        buf = new char[1024];
                        reader.close();
                        String xmlMsg= fileData.toString();
                        System.out.println("XMLMSG= " + xmlMsg);
                             PrintWriter outresp = res.getWriter();
                             outresp.println(xmlMsg);
                             outresp.close();
              }catch (Exception e) {
                   e.printStackTrace();
              public void doPost(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException {
                   doGet(req, res);
    XML FILE:
    <?xml version="1.0"?>
    <?xml-stylesheet type="text/xsl" href="xml-to-html.xsl"?>
    <sparql
    xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
    xmlns:xs="http://www.w3.org/2001/XMLSchema#"
    xmlns="http://www.w3.org/2005/sparql-results#" >
    <head>
    <variable name="book"/>
    <variable name="title"/>
    </head>
    <results ordered="false" distinct="false">
    <result>
    <binding name="book">
    <uri>http://example.org/book/book6</uri>
    </binding>
    <binding name="title">
    <literal>Harry Potter and the Half-Blood Prince</literal>
    </binding>
    </result>
    <result>
    <binding name="book">
    <uri>http://example.org/book/book5</uri>
    </binding>
    <binding name="title">
    <literal>Harry Potter and the Order of the Phoenix</literal>
    </binding>
    </result>
    <result>
    <binding name="book">
    <uri>http://example.org/book/book4</uri>
    </binding>
    <binding name="title">
    <literal>Harry Potter and the Goblet of Fire</literal>
    </binding>
    </result>
    <result>
    <binding name="book">
    <uri>http://example.org/book/book3</uri>
    </binding>
    <binding name="title">
    <literal>Harry Potter and the Prisoner Of Azkaban</literal>
    </binding>
    </result>
    <result>
    <binding name="book">
    <uri>http://example.org/book/book2</uri>
    </binding>
    <binding name="title">
    <literal>Harry Potter and the Chamber of Secrets</literal>
    </binding>
    </result>
    <result>
    <binding name="book">
    <uri>http://example.org/book/book1</uri>
    </binding>
    <binding name="title">
    <literal>Harry Potter and the Philosopher's Stone</literal>
    </binding>
    </result>
    </results>
    </sparql>

    Error processing resource http://127.0.0.1:8080/testReplyingXML/xml-to-html.xs...
    Well, if one more character had been deleted from that message then you would have a problem. But as it is, the error message says there's an error processing a resouce whose name ends with "xml-to-html.xs" followed by something. That would be the stylesheet if I'm not mistaken. Most likely the browser can't find it at the URL mentioned in the error message.

  • Worksets not visible in the top level navigation

    Hi all,
                 I installed ESS business package and.ESS 600 sp08.Everything is fine but the worksets of the ESS role are not coming in the top level navigation (2nd level).They are visible in the detailed navigation.
    I checked the option in the worksets .
    the property invisible in navaigation area .It is set to No.So no issues.
    Still it is not visible
    Any clues please.
    Thanx and Regards,
    rajesh

    Hi,
    As Rightly said
    1)  First copy ESS folder created in "Content provided by SAP" under "Portal Content".
    2)  Copy standard ESS Role for u r customization
    3)  Open Custom Role "Employee Self Service"
    4)  Property Category : Navigation
    5)  Check Entry Point property
    It shuld be NO for Role but It shuld be YES for Workset ESS under it as per standard then Its Fine
    6)  Then Assign this role to u r User thru UserAdmin
    7)  Refresh
    It shuld work !!!!
    Reward Points !!!  If helpful
    Edited by: PK on Mar 25, 2008 11:59 AM

  • Enumerating projects in solution, only gives top level projects??

    Hi,
    I have a VSPackage and I want to enumerate all the projects in the solution. To do this I use:
    var dte = Package.GetGlobalService(typeof (SDTE)) as DTE;for (var i = 1; i <= dte.Solution.Projects.Count; i++)                {                    var project = dte.Solution.Projects.Item(i); //do something here }
    This works well on simple solutions but if I have my solution organised into folders then I just get back a list of the folders.
    For example, if the solution looks like this in solution explorer:
    Solution.Sln
     \Business
           \ABC.proj
            \DEF.proj
      \ZX1.proj
      \Data
              \HIJ.proj
    I will get back a project for \Business, \ZX1 and \Data (which aren't even projects) so it looks like the enumeration isn't projects but top level items in the solution.
    Is this correct? Is there an easy way to get all projects or do I need to recurse down and get every project item? 
    ed

    That doesn't sound right. I would have thought the Projects collection would just contain the actual project, but I almost never use those solution folders, so it's not something I've encountered before.
    A better option might be
    IVsSolution.GetProjectEnum. I'm pretty sure that works as documented.
    Sincerely,
    Ed Dore

  • Top level class ?

    hi,
    i am preparing the sun certified java progammer, there's some questions involving "top level class", i don't understand what is a top level class ? can anyone give me some information about it ? is it a class at the top of a package hierarchie like class Object ????
    thanks for your help

    hi,
    i am preparing the sun certified java progammer,
    there's some questions involving "top level class", i
    don't understand what is a top level class ? can
    anyone give me some information about it ? is it a
    class at the top of a package hierarchie like class
    Object ????No. See
    http://java.sun.com/docs/books/jls/second_edition/html/packages.doc.html#26783
    Jim S.

  • How to make  menuBar UI listen for top level click

    Hi,
            The  menubar only listen to the sub level menu item(i mean click), and I  would like to make menubar listen to top level also.
    for eg:
    NEWS-> worldnews.
    it listen the sublevel item worldnews ,i would like to make top level NEWS also.
    I  tried using selected index. sometimes  -1 was returned when I clicked  the “NEWS” item.  I assume this is because it has sub-menu items.
    can anyone give solution for this???????

    hi Neobox75,
    I have created an air application for a  news website( i didnt finsh it fully) . I display the images ,news everythng using feed. I used httpservice to get the values from the feed. now my problem is if i deploy this package to the user means if he has the internet connection ...All my information wil be displayed to him as i read all the information through feed .  if the network conection is not available(offline) means i have to  display the previous news and images to him( if v use timer to refresh it wil be cached in user system  but i dnt knw how to retreive from cache if the user is offline ).how it can be done please give the solution for it...
    regards,
    divya.

  • Javadoc question about top-level specification

    Quoting
    http://java.sun.com/j2se/javadoc/writingapispecs/index.html#top-level
    Top-Level Specification
    The top-level specification is composed of those specifications that apply to the entire set of packages. It can include assumptions that underlie the other specifications, such as all objects are presumed to be thread-safe unless otherwise specified.
    In addition to the class specific requirements, there are overall Java platform API documentation requirements with respect to handling unchecked exceptions (exceptions that derive from java.lang.RuntimeException). It would be helpful to develop some blanket statements that describe the general situations when a Java application should be prepared to encounter one or more RuntimeExceptions.
    My question is how do you get an HTML file included in the Javadocs so they show at the top level where the packages are listed?
    Thanks
    Bill

    Yes, that would seem to be apply, but I had some questions.
    1. This seems to suggest that overview.html will be added to the package-summary generated for each class. That is not what I want.
    2. I could not make it work. Here is the command I am using to build the javadocs.
    javadoc  -d docs -author -overview overview.html -doctitle "CkEntry / CkViewer Application and APIs" -sourcepath d:\workspace\ckviewer\src cprs.as400 cprs.ckentry cprs.ckviewer cprs.pc5250 cprs.roi cprs.util neva vistech.imageviewer vistech.jai.render vistech.util 1>jdocs_out1.txt 2>jdocs_out2.txtjavadoc has a problem with overview.html. This is the single line in jdocs_out2.txt:
    javadoc: Error while reading file overview.htmlNot very informative. Overview.html is in the folder identified by -sourcepath
    Thanks for looking at this. I appreciate the help.

  • Possible to Have ToC Default to Show Only Top Level (collapse sublevels)?

    Howdy!
    I'll bet I'm not the only one wishing for this.  Let's say you're using Captivate 4's Table of Contents feature with a longish movie of Cp slides, which is chunked into bite-size sections content-wise.  In the ToC, though, you can't mimic that same organization scheme; at least, the learner would first need to collapse all the ToC folders you've created so they see only the top-level listing.
    This can be a critical issue:  keeping the at-first-glance list in the ToC brief enough to be inviting to learners, yet allowing learners to drive which details are currently visible.
    A movie's topical hierarchy could be along these lines, for example ...
    Section 1 - National Brands
    What are National Brands?
    Why Are They Important to Our Business?
    Working with Nat. Brands
    Practice Your Knowledge
    Section 2 - International Brands
    What are International Brands?
    Why Are They Important to Our Business?
    Working with Intl. Brands
    Practice Your Knowledge
    You'd like to organize the ToC to show only the section titles (1st level) and to suppress the 2nd-level detail (slide titles) until the learner chooses to expand the folder to see those details.
    I've tried things like grouping the slides into sections in the Storyboard view and organizing the slides into sections strictly within the ToC -- both to no avail.
    Has anyone solved for this need yet?
    I'm all ears, and you'd be doing learners of the world a huge favor.
    Thanks!

    Hi, Jim.
    Thanks for being 'on the case' and looking into this so quickly.  Your
    findings are encouraging, although my user base is generally working with
    IE 6 and FP8 or 9.
    Since the only thing I may influence is getting  IT to help push out FP10,
    I'm hoping it's more of a player- than a browser-version issue.
    I'll test things out by Monday and let you know the results.  Wish me luck!
    Dave
                                                                                    From:       Jim Leichliter <[email protected]>                                                                               
    To:         Dave Tressler <[email protected]>                                                                               
    Date:       03/26/2010 06:02 PM                                                                               
    Subject:    Possible to Have ToC Default to Show Only Top Level (collapse
                  sublevels)?                                                                                
    Dave,
    I just tested this on my local web server and it worked fine.  I created a
    blank project with 8 slides.  Created my TOC with grouping... 2 slides in
    each group.  I turned on self paced learning.  I tried with and without the
    widget and it picked up where I left off in either case.  See
    https://docs.google.com/leaf?id=0B86WuEq6SVwRNWIwMjhjODctMjE2Yy00MWE2LWI5YzEtMGQxYzNjOWQ0Z mI2&hl=en. 
    I published using FP10 and IE8 to view.  Notice any difference between
    your project and this one?
    Thanks,
    Jim Leichliter

  • Inactive component cost not rolled up to top level item

    Hi
    Our scenario is as follows: we have a top level item with a BOM. And some components of the BOM  are having material status u2018inactiveu2019. Inactive means materials will not procured and sold, however we could have inventory which can be consumed in production of other materials. In other words inactive items are like old items. These inactive items already have costing value. And we donu2019t want to recost inactive items.
    Having described above scenario, the requirement here is when we run costing for top level item, system should take costing value of inactive items  and roll up into top level item costing which is NOT happening now. Client donu2019t want to recost inactive items. The reason for not recosting inactive items is the recosting could change cost of inactive items significantly.  We are using 4.7 version and standard costing.
    Would appreciate any ideas or suggestions in this regard.
    thanx
    Sunil

    Thanks Young for the reply. 
    We already set 'do not cost' indicator for inactive components. And these inactive components do have standard costs valid up 10 12/31/2999.  It seems bom explosion is excluding these materials. it is ok to exclude. However the existing standard cost of these inactive components did not roll up in to top level. when I checked the costing status log, it says material ABCDF123 in plant 3344 has material status 40: Inactive.
    I checked BOM as well and inactive component is flagged as 'relevant for costing'.
    We are using following valuation varaiant
        Strategy Sequence ->  1. Planned Price 1    2.Standard Cost
        Transfer Control - Complete Transfer
    thnx

  • How do I use CreateBookmarksFromGroupTree and NOT guid in the name for my top level?

    Post Author: Barbdcg
    CA Forum: Deployment
    I have a report that I have created that uses uses groups and I wanted export a PDF using the CreateBookmarksFromGroupTree option. While that works, I get an ugly top level bookmark name that starts with the name of my report, then followed by a GUID;
    Report {49E72CC5-7FFD-44F8-831B-EA8F543F7D82}.rpt
    So, how do I Put in a name of my own choosing as the top-level bookmark or at least get rid of the guid?
    Any help or suggestions would be appricated.
    Thanks,
    Barb

    Post Author: Barbdcg
    CA Forum: Deployment
    Still no answer??? I can not figure this one out!!  HELP!!!

  • How do I use CreateBookmarksFromGroupTree and NOT get a "temp_" for my top level?

    I have a report that I have created that uses uses groups and I wanted export a PDF using the CreateBookmarksFromGroupTree option. While that works, I get an ugly top level bookmark name that starts with "temp_" then followed by two GUIDs "temp_13fef8e3-30ec-4bc5-ba77-b55d23c95e8f {87823BCB-7789-407C-8A7F-5096BE07A83E}".
    So, how do I:
    1) Get rid of this top level so it matches the Crystal Viewer (which has multiple top level bookmarks)
    2) Put in a name of my own choosing as the top-level bookmark.
    <!break>
    Any help or suggestions would be appricated.
    Thanks,
    Jim

    I would very much like to know how to avoid this also!!!

  • Front panel of a vi pops up when i start my top level vi how can i stop this

    i have a vi that whos front panel should display when the user clicks a front panel button(test instructions),
    however this vi pops up when i run the top level vi. I can manually close the vi, but how do i stop this?
    i tried modifying the Sub VI Set up properties, but that doesnt work.
    Solved!
    Go to Solution.

    Hi jknapp,
    As egraham has pointed out, you can customize the window appearance of your sub VI from the VI Properties.  If you go to File » VI Properties, then under Category select Window Appearance and then Customize..., you should be able to control how the sub VI appears.  Hope this helps!
    Taylor G.
    Product Support Engineer
    National Instruments
    www.ni.com/support

  • How can I close all open subVI front panels, without closing my top level VI front panel when all VIs are built into executables?

    I'm using the code shown in the sample VI discussed here: http://digital.ni.com/public.nsf/allkb/353A696A3F393D9B86256E8B007A2912
    to close all open VIs except my top level VI.  My top level VI is actually a separate executable and the sub-VIs are their own executables.  All reside under the same project.  It works very well if I'm running in LabView but will not work when I build them.  I added all the sub-VIs to the Always Include box in my top level VIs properties which did nothing.  I also tried adding them to the Startup VIs box.  This allowed me to close them all programmatically from the top level VI but it also open all the VIs at once (which was expected and not desired).  I think the problem is the executables are not able to see outside their own memory space so the top-level VI never finds any other open front panels to close.  Is this correct?  Is there another way to go about doing this? 
    Thanks!

    Where do I begin…..
    I’m using a “server” to control 4 “client” PCs.  My server opens references to 4 VIs on each client then executes them sequentially.  So on a normal day, the server will run everything itself and I will have no contact with the clients.  But on a several occasions, I’ve needed the ability to walk up to one of the clients and run just one of the 4 VIs. 
    We are updating from LabView 6.1 to 8.5 and we want to run executables rather than VIs for various reasons.  I have a new VI running on the client PCs who’s only function is to initialize the shared variables and open/close the VIs.  I initially thought of making the remaining 4 VIs sub-VIs but I will loose the ability to run them individually.  I think I would also have to rewrite the VI running on the server since the 4 references it originally opened do not exist.  I don’t think you can open a reference to a sub-VI on another PC.  Can you???
     As you can see, this is a huge mess.  I’m still pretty new with LabView so any help you can provide would be great. 

Maybe you are looking for