[BUG] @example : the generated code block of the doc gets unexpected spaces

[rdkmaster]

Overview of the issue

the generated code block of the doc gets unexpected spaces, see the image below

Operating System, Node.js, npm, compodoc version(s)

win10 64, node6.10, npm 3.10

Angular configuration, a package.json file in the root folder

yes

Compodoc installed globally or locally ?

locally

Motivation for or Use Case

the generated code block of the doc gets unexpected spaces

Reproduce the error

use the comment:

    /**
     * Shows all events on a given day. Example usage:
     *
     * ```html
     * <mwl-calendar-day-view
     *             [viewDate]="viewDate"
     *             [events]="events">
     * </mwl-calendar-day-view>
     * ```
     */

Related issues

no

additional info

[rdkmaster]

[bartvanvliet]

@rdkmaster

It's because you are using the ```html tag as you would in markdown.

Please supply it like this:

/**
  * Shows all events on a given day. Example usage:
  *
  * @example
  * <mwl-calendar-day-view
  *             [viewDate]="viewDate"
  *             [events]="events">
  * </mwl-calendar-day-view>
  */

[rdkmaster]

I tried @example seconds ago, and the example is gone!

[bartvanvliet]

@rdkmaster Where did you place the @example comment?

It should be at root level for example:

/**
 * The datagrid component for displaying lists of data.
 *
 * @example
 * <sr-datagrid
 *               [datagridFormat]="datagridFormat"
 *               [loading]="loading"
 *               [(rows)]="rows">
 *               <sr-datagrid-search
 *                 (onSearch)="onSearch($event)"></sr-datagrid-search>
 *               <sr-datagrid-button
 *                 [textTranslationKey]="'GRID.ADD_USER'"
 *                 (onClick)="onClick($event)"></sr-datagrid-button>
 *               <sr-datagrid-toggle
 *                 (onSwitch)="onSwitch($event)"></sr-datagrid-toggle>
 * </sr-datagrid>
 */
@Component({
  selector: 'sr-datagrid',
  templateUrl: './datagrid.component.html',
  styleUrls: []
})
export class DatagridComponent implements OnInit {}

[rdkmaster]

I copied the example from here, and here is my code

    /**
     * Shows all events on a given day. Example usage:
     *
     * @example
     * <mwl-calendar-day-view
     *             [viewDate]="viewDate"
     *             [events]="events">
     * </mwl-calendar-day-view>
     */
    test2() {

    }

[bartvanvliet]

@rdkmaster That's not on the root level. You are giving an example to a function called test. Look at my example 😄

[rdkmaster]

what do you mean by root level? Are u saying that the @example can be only used outter of the class which means "the root level"?

I have rolled back my code, and I can't try it now, maybe I'll try this sometime later.

[bartvanvliet]

@rdkmaster Outer class level indeed.

[rdkmaster]

ok thanks, outter of the class seems to be quite a limit.

Is there any way to use the markdown style code block and avoid the unexpected spaces?

[vogloblinsky]

I confirm this is not normal to doesn't support @example for inner function or properties of class.
Working on that tomorrow.

[bartvanvliet]

@vogloblinsky Sorry, Didn't know this was actually not expected behaviour ☹️

[vogloblinsky]

@Kapulara
It should be but i miss to test it everywhere (outter class and inside for functions etc).
Thanks for helping @rdkmaster.

[lock]

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.