[Jsdoc-user] @package tag and static object
Status: Inactive
Brought to you by:
mmathews
From: <s.c...@wa...> - 2006-09-18 09:24:52
|
Hello, I try to use @package but JSDOC doesn't generate nothing except summary. I've put bellow my source code I use this command line to launch process : C:\>perl jsdoc/jsdoc.pl --project-name Concentre --package-naming -r -d ../doc/javascript ../share/concentre/ I'm not sure to understand "--package-naming" arguments Moreover, I would like to know if it exists a mean to declare=20 private/public vars and static vars/method. In my code bellow I would like to declare as private "xliff" var and "message", "regexp" objects. My project uselot of "static" Object that are faster than dynamic. It's a command way to declare static object as this. I hope that someone could help me Thanks Regards S=E9bastien ----------------------------- my code ------------------------------ /** * @fileoverview This file add support for XLIFF Internationalization (I18N) file * * @author S=E9bastien Cramatte scr...@ze... * @version 0.1 */ /** @package ConcentreFactory.i18n */ /** @class */ ConcentreFactory.i18n =3D { =20 xliff : null, messages : {}, =20 regex : new RegExp(/%s/g), /** * Load XLiff resource file * @param {string} XLiff source file uri */ load : function (src) { this.xliff =3D XMLDocument.loadURI(src); }, /** * Return translated String * @param {string} XLiff @resname attribute * @param {array} Replace all %s by array values * @type String * @return Translated string */ translate : function (res, attrs) { if (!this.messages[res]) { this.messages[res] =3D SimpleXPATH.evaluate(this.xliff, this.xliff.documentElement,"/xliff/file/body/trans-unit[@resname=3D'"+res= +"']/source/text()").iterateNext().nodeValue; } =20 =20 return this.messages[res].replace(i18n.regex, function (e) { return attrs[i18n.regex.lastIndex] } ); } }; |