Results 1 to 3 of 3

Thread: slice2html: Wrong summary from multi-paragraph comments

  1. #1
    cebix is offline Registered User
    Name: Christian Bauer
    Organization: AREVA NP
    Project: Diagnostics frontend for industrial I&C
    Join Date
    Jun 2007
    Location
    Erlangen, Germany
    Posts
    10

    slice2html: Wrong summary from multi-paragraph comments

    When using the method suggested by section 4.22.1 of the Ice manual for having multiple paragraphs in a documentation comment:
    Code:
    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.

  2. #2
    marc's Avatar
    marc is offline ZeroC Staff
    Name: Marc Laukien
    Organization: ZeroC, Inc.
    Project: The Internet Communications Engine
    Join Date
    Feb 2003
    Location
    Florida
    Posts
    1,860
    Can you try adding a space before the </p>?

    Code:
    /**
    * 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).
    Last edited by marc; 10-23-2008 at 10:11 AM.

  3. #3
    cebix is offline Registered User
    Name: Christian Bauer
    Organization: AREVA NP
    Project: Diagnostics frontend for industrial I&C
    Join Date
    Jun 2007
    Location
    Erlangen, Germany
    Posts
    10

    Thumbs up

    Quote Originally Posted by marc View Post
    Can you try adding a space before the </p>?
    OK, this works. Maybe this should be pointed out in the manual.

    Thanks,
    Christian

Thread Information

Users Browsing this Thread

There are currently 1 users browsing this thread. (0 members and 1 guests)

Similar Threads

  1. Replies: 6
    Last Post: 10-14-2010, 03:58 PM
  2. Replies: 3
    Last Post: 01-20-2010, 06:48 PM
  3. slice2html bad summary links to external modules
    By jrray in forum Bug Reports
    Replies: 3
    Last Post: 04-04-2009, 07:40 PM
  4. Replies: 2
    Last Post: 10-20-2008, 08:49 AM
  5. New streaming API comments
    By annekat in forum Comments
    Replies: 5
    Last Post: 03-06-2005, 03:40 PM

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •