Maven Doxia

Add comments to sink API

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: 1.0-alpha-8
  • Fix Version/s: 1.1
  • Component/s: Sink API
  • Labels:
    None
  • Number of attachments :
    0

Description

Comments are often an important part of source documents, they should be preserved by doxia transformations.

Issue Links

Activity

Hide
Vincent Siveton added a comment -

I updated the javadoc so do you think that the doc for sink api is enough?

Show
Vincent Siveton added a comment - I updated the javadoc so do you think that the doc for sink api is enough?
Hide
Lukas Theussl added a comment -

What I meant is to add a method like

void comment( String text )

to the Sink interface that allows you to translate eg an apt comment

 
~~ a comment
 

into an xml comment:

 
<!-- a comment -->
 
Show
Lukas Theussl added a comment - What I meant is to add a method like
void comment( String text )
to the Sink interface that allows you to translate eg an apt comment
 
~~ a comment
 
into an xml comment:
 
<!-- a comment -->
 
Hide
Dennis Lundberg added a comment -

This sounds like a good addition to the API. At least some of the generated formats supports comments, the others can just do nothing.

Show
Dennis Lundberg added a comment - This sounds like a good addition to the API. At least some of the generated formats supports comments, the others can just do nothing.
Hide
Lukas Theussl added a comment -

Done in r583267. Comments are implemented in Xdoc, Xhtml and Docbook parsers and sinks, and in AptSink. AptParser is still to do.

Show
Lukas Theussl added a comment - Done in r583267. Comments are implemented in Xdoc, Xhtml and Docbook parsers and sinks, and in AptSink. AptParser is still to do.

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: