Using the code tag with plsqldoc

[Bergeroy]

Hi,

It seems like using the

tag in a comment do something more than just using the courrier font.  It also affects the formatting of the entire paragraph in which it is used.

If you try the two following examples, you'll see the difference.

create or replace package test1 is
  /** Comment paragraph without the code tag.  It as many lines that will not be broken
      in the resulting HTML page.  Also, there will not be any non braking spaces on
      the begining of each lines.
  */

  /** Comment for v_test */
  v_test char(1);
end test1;
/

create or replace package test2 is
  /** Comment paragraph with a <code>code

tag. Each line are broken with the br tag
in the resulting HTML page. Also, there is non braking spaces on
the begining of each lines for the next paragraph.

Some sentence containing a code tag on the next line
as

path="/logon"

.

*/

/** Comment for v_test */
v_test char(1);
end test2;
/

Thank you for your help

 

[Bergeroy]

In reference to the precedent post, I'm trying hre to show my codification the sameway as it really is:

create or replace package test1 is
  /** Comment paragraph without the code tag.  It as many lines that will not be broken
      in the resulting HTML page.  Also, there will not be any non braking spaces on
      the begining of each lines.
  */

  /** Comment for v_test */
  v_test char(1);
end test1;
/

create or replace package test2 is
  /** Comment paragraph with a <code>code</code> tag.  Each line are broken with the br tag
      in the resulting HTML page.  Also, there is non braking spaces on
      the begining of each lines for the next paragraph.

         Some sentence containing a code tag on the next line
         as <code>path="/logon"</code>.

  */

  /** Comment for v_test */
  v_test char(1);
end test2;
/

Thank you for your help

 

[Marco Kalter]

This is correct. The tag will use a fixed space font and will keep all formatting. This is necessary for actual program code in your documentation.

If you only want to use a fixed space font (and the standard formatting), use the and tag instead.

------------------
Marco Kalter
Allround Automations

 

[Bergeroy]

Hi,

That behavior is not the same as the one with javadoc. I would like to have fixed font spacing only between by

tags and not for all the other paragraphs around it.

If you look carefully in the next example, you see that the weird behavior occurs even in the paragraphs that don't have the <code> tag.

[quote][code]
create or replace package test2 is
  /** Comment paragraph with a code tag.  Each line are broken with the br tag
      in the resulting HTML page.  Also, there is non braking spaces on
      the begining of each lines for the next paragraph.

         Some sentence containing a code tag on the next line
         as <code><path="/logon">

.
*/

/** Comment for v_test */
v_test char(1);
end test2;
/
[/code][/quote]

Thank you

 

[Marco Kalter]

The tag does indeed incorrectly affect the entire comment block. We'll fix this.

------------------
Marco Kalter
Allround Automations

 

[Bergeroy]

Hi,

I'm trying again the CODE tag with the 1.1.4 version of plsqldoc. There seem to be some improvements but there is always an annoying BR on the line before the one that got a CODE tag.

So

create or replace package test2 is

  /** Sentence without a CODE tag that continues on the next
      line without beeing affected by a BR tag.
      Some sentence containing a code tag on the next line
      as <code><path="/logon"></code>.  */

  /** Comment for v_test */
  v_test char(1);

end test2;

produces something like

<P CLASS="MAIN_TITLE">Package test2
Sentence without a CODE tag that continues on the next line without beeing affected by a BR tag.

Some sentence containing a code tag on the next line

as <code><path="/logon"></code>.

[/TD][/TR][/TABLE]

Is that problem scheduled to be resolved in a near to come version of plsqldoc ?

Thank you

 

[Marco Kalter]

Yes, I noticed this after checking out your previous message. We will fix this too.