slice2html: Wrong summary from multi-paragraph comments

cebixcebix Christian BauerOrganization: AREVAProject: Diagnostics frontend for industrial I&CMember
When using the method suggested by section 4.22.1 of the Ice manual for having multiple paragraphs in a documentation comment:
module test {
interface foo {

/**
* This is a comment for some Slice construct.</p>
*
* <p>This comment appears in a separate paragraph.
**/
void bar();

};
};
slice2html puts both paragraphs into the summary of the bar() operation (expected behavior: only the first sentence is used as the summary). It also generates invalid HTML: the </p> appears inside an open <dd> element.

I'm using Ice 3.3.0 under openSUSE 11.0.

Comments

  • marcmarc FloridaMarc LaukienOrganization: ZeroC, Inc.Project: The Internet Communications EngineAdministrators, ZeroC Staff ZeroC Staff
    Can you try adding a space before the </p>?
    /**
    * This is a comment for some Slice construct. </p>
    *
    * <p>This comment appears in a separate paragraph.
    **/
    

    slice2html does not interpret embedded HTML, so it cannot detect the end of the summary sentence. The end of the summary sentence must be a '.' followed by whitespace (space, tab, newline).
  • cebixcebix Christian BauerOrganization: AREVAProject: Diagnostics frontend for industrial I&CMember
    marc wrote: »
    Can you try adding a space before the </p>?
    OK, this works. Maybe this should be pointed out in the manual.

    Thanks,
    Christian
Sign In or Register to comment.