[vsipl++] [patch] Document div, mul, and sub elementwise functions

Jules Bergmann jules at codesourcery.com
Wed Aug 6 13:59:09 UTC 2008


> This looks good (literally so ! :-) ). I have a couple of (small) 
> issues, though:
> 
>> +<section id="functionref_div">
>> + <title><literal>div</literal></title>
> 
> What is the reason you use the 'literal' element in the above ? Is it to 
> force a specific output style ? If you really want to mark this up 
> specially, I'd suggest any of the more expressive markups, such as 
> 'code'. (The same issue came up in a patch from Mike.)

I have it as literal partly because that is how add.xml did it (lame 
excuse :), and partly because it should be treated as a code fragment 
fontifically.  I'll use <code> instead.

> 
> 
>> +  <title>Elementwise Functions</title>
>>    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
>> href="add.xml" />
>> +  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
>> href="div.xml" />
>> +  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
>> href="mul.xml" />
>> +  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
>> href="sub.xml" />
> 
> I would suggest we put the namespace declaration (the 'xmlns:xi' 
> attribute) into the root element of each xml file, so we don't need to 
> repeat it each time we use xi:include.

Ok.  Is there an example of doing that for us XML neophytes?

> 
> Finally, I noticed in your pdf manual the same thing Mike complained 
> about in his output: the formatting of the function synopsis is wrong, 
> as the function parameter types are declared outside the function 
> prototype. As I mentioned in a reply to Mike, the fix for this is to 
> customize the html and fo - generating stylesheets so ansi-style 
> formatting is used, not k&r.
> (I can submit a fix for this in a separate patch, as it affects the 
> csl-docbook module only.)

I agree the output looks ugly.  How long would a fix take?  If it is a 
couple of hours, go for it.  Otherwise, let's punt until another year, 
as Mark suggests.

				-- Jules

-- 
Jules Bergmann
CodeSourcery
jules at codesourcery.com
(650) 331-3385 x705



More information about the vsipl++ mailing list