Re: kernel-doc: what is the purpose of ""?

2007-01-06 Thread Jan Engelhardt

On Jan 6 2007 10:00, Randy Dunlap wrote:
>On Sat, 6 Jan 2007 09:44:39 -0500 (EST) Robert P. J. Day wrote:
>
>>   according to the kernel-doc HOWTO, the following should be
>> "highlighted" in some way if found in the extractable documentation of
>> your source file:
>> 
>>   '_name' - name of a structure (up to two words including 'struct')
>> 
>> but examples of that, at least in the HTML, are simply printed in
>> regular font prefixed with '&' -- i don't see that any "highlighting"
>> is being done.
>
>The struct name is highlighted in 'man' output mode.
>Not done in text or html output modes.

 is quite ambiguous when it comes near C code. So far,
I have only used e.g. %NULL (%CONSTANT) since % is not an unary 
operator in C. On the other side, no marking up of any "struct".

-`J'
-- 
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to [EMAIL PROTECTED]
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/


Re: kernel-doc: what is the purpose of ""?

2007-01-06 Thread Randy Dunlap
On Sat, 6 Jan 2007 09:44:39 -0500 (EST) Robert P. J. Day wrote:

> 
>   according to the kernel-doc HOWTO, the following should be
> "highlighted" in some way if found in the extractable documentation of
> your source file:
> 
>   '_name' - name of a structure (up to two words including 'struct')
> 
> but examples of that, at least in the HTML, are simply printed in
> regular font prefixed with '&' -- i don't see that any "highlighting"
> is being done.

The struct name is highlighted in 'man' output mode.
Not done in text or html output modes.

>   the intermediate XML contains simply "struct", which certainly
> doesn't suggest any special processing or highlighting.
> 
>   am i missing something?

---
~Randy
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to [EMAIL PROTECTED]
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/


kernel-doc: what is the purpose of ""?

2007-01-06 Thread Robert P. J. Day

  according to the kernel-doc HOWTO, the following should be
"highlighted" in some way if found in the extractable documentation of
your source file:

  '_name' - name of a structure (up to two words including 'struct')

but examples of that, at least in the HTML, are simply printed in
regular font prefixed with '&' -- i don't see that any "highlighting"
is being done.

  the intermediate XML contains simply "struct", which certainly
doesn't suggest any special processing or highlighting.

  am i missing something?

rday
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to [EMAIL PROTECTED]
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/


kernel-doc: what is the purpose of struct?

2007-01-06 Thread Robert P. J. Day

  according to the kernel-doc HOWTO, the following should be
highlighted in some way if found in the extractable documentation of
your source file:

  'struct_name' - name of a structure (up to two words including 'struct')

but examples of that, at least in the HTML, are simply printed in
regular font prefixed with '' -- i don't see that any highlighting
is being done.

  the intermediate XML contains simply amp;struct, which certainly
doesn't suggest any special processing or highlighting.

  am i missing something?

rday
-
To unsubscribe from this list: send the line unsubscribe linux-kernel in
the body of a message to [EMAIL PROTECTED]
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/


Re: kernel-doc: what is the purpose of struct?

2007-01-06 Thread Randy Dunlap
On Sat, 6 Jan 2007 09:44:39 -0500 (EST) Robert P. J. Day wrote:

 
   according to the kernel-doc HOWTO, the following should be
 highlighted in some way if found in the extractable documentation of
 your source file:
 
   'struct_name' - name of a structure (up to two words including 'struct')
 
 but examples of that, at least in the HTML, are simply printed in
 regular font prefixed with '' -- i don't see that any highlighting
 is being done.

The struct name is highlighted in 'man' output mode.
Not done in text or html output modes.

   the intermediate XML contains simply amp;struct, which certainly
 doesn't suggest any special processing or highlighting.
 
   am i missing something?

---
~Randy
-
To unsubscribe from this list: send the line unsubscribe linux-kernel in
the body of a message to [EMAIL PROTECTED]
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/


Re: kernel-doc: what is the purpose of struct?

2007-01-06 Thread Jan Engelhardt

On Jan 6 2007 10:00, Randy Dunlap wrote:
On Sat, 6 Jan 2007 09:44:39 -0500 (EST) Robert P. J. Day wrote:

   according to the kernel-doc HOWTO, the following should be
 highlighted in some way if found in the extractable documentation of
 your source file:
 
   'struct_name' - name of a structure (up to two words including 'struct')
 
 but examples of that, at least in the HTML, are simply printed in
 regular font prefixed with '' -- i don't see that any highlighting
 is being done.

The struct name is highlighted in 'man' output mode.
Not done in text or html output modes.

something is quite ambiguous when it comes near C code. So far,
I have only used e.g. %NULL (%CONSTANT) since % is not an unary 
operator in C. On the other side, no marking up of any struct.

-`J'
-- 
-
To unsubscribe from this list: send the line unsubscribe linux-kernel in
the body of a message to [EMAIL PROTECTED]
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/