251770 – I am using Custom Javascript library with custom methods in it, My issue is I am unable to figure out how to add documentation for method.

This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 251770 - I am using Custom Javascript library with custom methods in it, My issue is I am unable to figure out how to add documentation for method.

Summary: I am using Custom Javascript library with custom methods in it, My issue is I...

Status:	RESOLVED FIXED

Alias:	None

Product:	javascript
Classification:	Unclassified
Component:	Editor (show other bugs)
Version:	8.0.2
Hardware:	Other Windows 7 x64

Importance:	P3 normal (vote)
Assignee:	Petr Pisl

URL:
Keywords:

Depends on:
Blocks:

Reported:	2015-04-11 14:23 UTC by shferoz1
Modified:	2015-04-15 10:43 UTC (History)
CC List:	2 users (show)

See Also:
Issue Type:	DEFECT
Exception Reporter:

Attachments
It describes by issue (10.63 KB, image/png) 2015-04-11 14:23 UTC, shferoz1	Details
the screen Iam getting (10.63 KB, image/png) 2015-04-13 17:37 UTC, shferoz1	Details
snippet for Glidesystem (3.50 KB, application/javascript) 2015-04-14 09:04 UTC, shferoz1	Details
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.

Description shferoz1 2015-04-11 14:23:53 UTC

Created attachment 153137 [details]
It describes by issue

I am using Custom Javascript library with custom methods in it, My issue is I am unable to figure out how to add documentation for method.

Comment 1 Vladimir Riha 2015-04-13 07:39:55 UTC

Could you please provide the library and steps to reproduce the issue?

Comment 2 shferoz1 2015-04-13 17:37:08 UTC

Created attachment 153165 [details]
the screen Iam getting

Please find attachment for screen what I am getting. I am not able figure how to enter documentation.

Could you please help me out. It's not possible to share such a big library here.

Regards,
Feroz

Comment 3 Vladimir Riha 2015-04-14 06:49:53 UTC

I'm sorry but the screenshot is not enough, without reproducible case there is no much we can do. It could be caused by many things. 

Could you try to create a simple piece of code with similar syntax/coding style as used for the plugin (e.g. just one method etc.) and if it won't work, attach the the snippet here? It might not be about the actual code, but about the used coding style and code structure.

Comment 4 shferoz1 2015-04-14 09:04:53 UTC

Created attachment 153184 [details]
snippet for Glidesystem

Please find attachment for snippet.

I will be using this script to auto complete methods in any JS file. To try it out, create a new JS file, and type "gs." Once you type, it should pull up a list of options that you can use to complete your code.[As shown in earlier attachment]

FYI: I have not used any thing for documentation. I am new to Netbeans I don't have idea how to achieve this. 

My expectations from you are to help me on making documentation visible for each method when I move from one method to other.

I will be thankful for your kind consideration.

Comment 5 Vladimir Riha 2015-04-14 09:32:00 UTC

Please check [1], the JSDoc must starts with /**

/**
     * <p>getMessage(messageID, optionalArguments)</p>
     * <p>Retrieve message from UI messages. Note: if the UI message has a tick ('),
     *    there may be issues with the message in the script; to escape the ticks ('),
     *    use getMessageS(String, Object).</p>
     * @param messageID - ID of message
     * @param optionalArguments - Optional Arguments
     * @return the UI message as a string.
     */
    this.getMessage = function(messageID, optionalArguments) { };



[1] http://usejsdoc.org/about-getting-started.html

Comment 6 shferoz1 2015-04-15 10:43:06 UTC

Thanks, IT's working now.