Apidoc: multiple types in @apiParam

[hotaru355]

I use apiDoc for documenting JavaScript and would like to use @apiParam to show that an input parameter can be of different types. For example:

/**
 * @apiParam {Object|Number} options an options object or just a number
 */
function myFunc(options) {
}

Unfortunately, the above example gives an error in the parser:

error: Empty parser result. 
{ File: 'myfile.js',
  Block: 1,
  Element: '@apiParam',
  Source: '@apiParam {Object|Number} ..'
}

Is there a character other than the pipe that does not blow the parser? Or is there a way to escape the pipe character? Thanks!

[rottmann]

Currently name them mixed and add a description.
I check to allow this feature again, it was removed because of the the size and allowedValues parameters that can be added to a type.

[sebastiaanluca]

Same request for @apiResponse :)

@apiSuccess {string|integer|null} field Description

[AndrewHoos]

This would be nice, but something else that might be easier is to simply allow listing the same parameter more than once:

@apiParam {String} [Resources] A Resource label 
@apiParam {String[]} [Resources] A list of Resource labels

Right now this just lists the last one and ignores the first.

[allayli]

Hi, can file type param be supported in @apiParam ?

@apiParam {File} [Resources] A Resource File to be uploaded

Thanks.

[DragonAxe]

I have something to add to this conversation.
I'm trying to document a Java API and one of my @apiParams has a type of Set<Integer>
However apidoc throws an error because of the special characters: < >
Any tips or fixes?
< > doesn't work either.

[davidrapin]

+1 on this, this seems pretty critical

[skielo]

+1
I'm getting the same problem trying to document a C# class:
error: Empty parser result.
{ File: '.\\GoalsV2Module.cs', Block: 4, Element: '@apiSuccess', Source: '@apiSuccess (200) {Nullable<int>} goal.IntegrationId' }

Also it doesn't work with characters like: ? | ... etc

[rodrigogs]

+1 pretty basic

[StyleT]

any news here?

[webus]

any news ?

[tobernguyen]

+1

[LogansUA]

Still waiting for this :)

[tewnut]

How is the status for file type param?

[demisx]

+1

[cschaba]

+1

[OoDeLally]

+1

[kerberjg]

+1

[Schemiii]

+1

[NiklasMerz]

For a temporary solution se #573

[CrazySzg]

+1

[chetverikov]

+1

[chungryan]

+1

[greatzeze]

+1

[galaktuz]

+1

[demidovsky]

+1

[karankapur999]

+1

[jeffrey008]

+1

[NicolasCARPi]

The {String|Number} syntax works now.