[Laszlo-dev] How do I figure out what is generating the page for defaultdataprovider and httpdataprovider?

[Donald Anderson]

Henry,

Here are the changes I made.

To test,
    cd docs/src
    ant clean reference

Should create docs/reference/defaultdataprovider.html
and httpdataprovider.html with all the stuff in the comment.


Index: data/LzHTTPDataProvider.lzs
===================================================================
--- data/LzHTTPDataProvider.lzs (revision 8902)
+++ data/LzHTTPDataProvider.lzs (working copy)
@@ -379,6 +379,24 @@

  }

+/**
+  * <p>
+  * <varname>httpdataprovider</varname> is a global variable bound to  
the system default HTTP DataProvider.
+  * </p>
+  * This will be an instance of <classname>LzHTTPDataProvider</ 
classname>, which implements HTTP request
+  * transport. The default  value of the global  
<varname>defaultdataprovider</varname> is initially set to point
+  * to this same object.
+  * @access public
+  */
  var httpdataprovider = new LzHTTPDataProvider();
+
+/**
+  * <p>
+  * <varname>defaultdataprovider</varname> is a global variable bound  
to the system default DataProvider.
+  * </p>
+  * By default, this will be an instance of  
<classname>LzHTTPDataProvider</classname>, which will also be pointed  
to by
+  * the global <varname>httpdataprovider</varname>.
+ * @access public
+  */
  var defaultdataprovider = httpdataprovider;


On Apr 29, 2008, at 2:09 PM, Donald Anderson wrote:

> Henry - try putting a @access public
> at the end of the javascript comment.
> With your changes, and that, I am getting a docs/reference/ 
> defaultdataprovider.html
> and httpdataprovider.html that look pretty reasonable.
>
> On Apr 29, 2008, at 12:38 PM, Henry Minsky wrote:
>
>>
>> I'm trying to add docs to the declarations of "defaultdataprovider"  
>> and "httpdataprovider" which occur in
>> LzHTTPDataprovider.lzs. I assume that because they are global var  
>> declarations that that is where they
>> are being generated from.
>>
>> Adding doc of this form doesn't seem to generate anything in the  
>> output reference page. Is there some other
>> '@' directive I need to cause the doc strings to get picked up ?
>>
>> /**
>>   * <p>
>>   * <varname>httpdataprovider</varname> is a global variable bound  
>> to the system default HTTP DataProvider.
>>   * </p>
>>   * This will be an instance of <classname>LzHTTPDataProvider</ 
>> classname>, which implements HTTP request
>>   * transport. The default  value of the global  
>> <varname>defaultdataprovider</varname> is initially set to point
>>   * to this same object.
>>   */
>> var httpdataprovider = new LzHTTPDataProvider();
>>
>> /**
>>   * <p>
>>   * <varname>defaultdataprovider</varname> is a global variable  
>> bound to the system default DataProvider.
>>   * </p>
>>   * By default, this will be an instance of  
>> <classname>LzHTTPDataProvider</classname>, which will also be  
>> pointed to by
>>   * the global <varname>httpdataprovider</varname>.
>>   */
>> var defaultdataprovider = httpdataprovider;
>>
>>
>> -- 
>> Henry Minsky
>> Software Architect
>> hminsky at laszlosystems.com
>>
>
>
> --
>
> Don Anderson
> Java/C/C++, Berkeley DB, systems consultant
>
> voice: 617-547-7881
> email: dda at ddanderson.com
> www: http://www.ddanderson.com
>
>
>
>


--

Don Anderson
Java/C/C++, Berkeley DB, systems consultant

voice: 617-547-7881
email: dda at ddanderson.com
www: http://www.ddanderson.com




-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://www.openlaszlo.org/pipermail/laszlo-dev/attachments/20080429/e2f4d55e/attachment.html