[Laszlo-dev] [Platform-team] Need help to avoid doc build failures

[Donald Anderson]

Actually, it may have more to do with the implementations once being  
separated into
different classes, now are joined.  The doc generators are mighty  
simple, if you have

    if ($swf9) {
       class LzBrowser { .... }
    }

it will generate LzBrowser+swf9.html, regardless of whether this  
LzBrowser has
an identical API to the other LzBrowsers.  Obviously the cleanups and  
merging
happening now affect the persistence of these file names.

If you want to see the sort of change that I'm calling a  
rearrangement, do 'svn log -r8736'.


On Apr 18, 2008, at 6:57 AM, P T Withington wrote:

> [Redirecting to Laszlo-Dev]
>
> So by 'rearrangement' you mean if change which platforms a public  
> API applies to, e.g., if you make a public API generic instead of  
> platform-specific.
>
> Hm.  Should we ever have a platform-specific public API in the LFC?   
> Probably not...
>
> On 2008-04-18, at 06:33 EDT, Donald Anderson wrote:
>> Hey all, could I enlist your help on this?
>> As you do any lfc rearrangements, could you do:
>>
>> (cd docs/src; ant reference)
>>
>> and see if it builds.  It does require ruby, and yes it's 15 minutes.
>> But it will avoid broken doc links and broken builds.
>>
>> The error message usually gives everything you need to fix it:
>>
>>>
>>>    [exec] Error: broken link in doc navigation: LzBrowser 
>>> +swf7+swf8+swf9.html referenced from toc.xml does not exist
>>>    [exec]     maybe use LzBrowser.html?
>>>    [exec]     maybe use LzBrowserInterface.html?
>>>    [exec]     maybe use LzBrowserService.html?
>>>    [exec] Error: broken link in doc navigation: LzBrowser 
>>> +dhtml.html referenced from toc.xml does not exist
>>>    [exec]     maybe use LzBrowser.html?
>>>    [exec]     maybe use LzBrowserInterface.html?
>>>    [exec]     maybe use LzBrowserService.html?
>>>    [exec] 6 TODOs found in toc.xml
>>>    [exec] Error: docs/src/nav/toc.xml is out of date, see broken  
>>> link messages above
>>
>> Here's the fix:
>>
>> --- docs/src/nav/toc.xml	(revision 8769)
>> +++ docs/src/nav/toc.xml	(working copy)
>> @@ -149,8 +149,7 @@
>>    <category title="Scripting">
>>        <item title="handler" href="tag.handler.html" />
>>        <item title="event" href="tag.event.html" />
>> -        <item title="LzBrowser (swf)" href="LzBrowser 
>> +swf7+swf8+swf9.html" />
>> -        <item title="LzBrowser (dhtml)" href="LzBrowser 
>> +dhtml.html" />
>> +        <item title="LzBrowser" href="LzBrowser.html" />
>>        <item title="method" href="tag.method.html" />
>>        <item title="node (LzNode)" href="LzNode.html" />
>>        <item title="script" href="LzScript.html" />
>>
>> Thanks!
>>
>> - Don
>>
>> --
>>
>> 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