Examples & Tests

The files source all-in-a-tumble.c and source all-in-a-tumble.h are including all examples of the LinuxDoc HowTo documentation. These files are also used as a test of the kernel-doc parser, to see how kernel-doc content will be rendered and where the parser might fail.

And … The content itself is nonsense / don’t look to close ;-)

• kernel-doc Test
  • DOC sections
    • option :no-header:
    • multiple DOC sections
  • option :man-sect:
  • exported symbols
    • option :export:
    • options :export:, :exp-method:, :exp-ids:
    • option :internal:
    • Missing exports
  • SYSCALL macro
• source of all-in-a-tumble.[ch]
  • source all-in-a-tumble.h
  • source all-in-a-tumble.c
• kernel-doc from all-in-a-tumble.[ch]
  • kernel-doc from all-in-a-tumble.h
  • kernel-doc from all-in-a-tumble.c
• rendered all-in-a-tumble.[ch]
  • all-in-a-tumble.h
    • About Examples
    • trace_block_touch_buffer
    • trace_block_dirty_buffer
    • Theory of Operation
    • multiple DOC sections
    • lorem ipsum
    • struct my_struct
    • struct my_long_struct
    • union my_union
    • enum my_enum
    • typedef my_typedef
    • rst_mode
    • vintage
    • struct nfp_flower_priv
    • enum foo
    • struct something
    • struct lineevent_state
  • all-in-a-tumble.c
    • user_function
    • user_sum
    • internal_function
    • sys_tgkill
    • enum rarely_enum
    • struct rarely_struct