Discussion :

[SuperArbre]

Bonjour à tous,

Je suis débutant en JavaScript et je souhaite utiliser JSDOC comme framework pour générer ma documentation.
Malheureusement après presque une journée à essayer de générer la documentation je n'arrive toujours pas.
Mon fichier JavaScript est un peu particulier puisqu'il s'agit de javascript pour indesign.

Est-ce que quelqu'un sait comment ignorer les erreurs du type
#include n'existe pas? Car dans indesign mon script est fonctionnel.

D'avance, merci de votre aide!

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
#include "Tools.jsx"
 
function Document_tools(){
}
 
 
/**
 * function who package a document and his link
 * @param the save dir path
 * @return the new doc path
 * @throw error if the package occured an error
 **/
Document_tools.save_with_package = function(doc, directories_path_str) {
    var result_package = false;
	var current_date = new Date();
	var folder_package = Folder (directories_path_str);
	if (folder_package.exists == false) {
        folder_package.create();
    }
	var doc_file = doc.fullName;
	var current_folder = Folder (folder_package + "/" + Tools.format_date(doc_file.modified) + "_" + Tools.format_time(current_date) + "__" + doc.name);
	current_folder.create();
    /**bool packageForPrint (to: File, copyingFonts: bool, copyingLinkedGraphics: bool, copyingProfiles: bool, updatingGraphics: bool, 
      *  includingHiddenLayers: bool, ignorePreflightErrors: bool, creatingReport: bool[, versionComments: string][, forceSave: bool=false])
      **/
    result_package = doc.packageForPrint(current_folder, false, true, false, true, false, true, false);
    if(!result_package){
        throw new Error("il y a eu un problème lors de l'assemblage");
    }
    return current_folder + "/" + doc.name;
}

[NoSmoking]

Bonjour,
je ne sais pas si cela peut te servir
http://www.indd-skript.de/idshelper/.../idsTools.html

[SuperArbre]

Hello,

Merci pour ta réponse, c'est très sympa… Je connais déjà cette librairie puisque j'ai déjà lu un livre de cet auteur …
En fait mon problème c'est vraiment que mon fichier JavaScript n'est pas considéré comme valide avec JSDOC et que donc je reçois une erreur…

Est-ce que quelqu'un sait comment générer une documentation avec une fichier JavaScript comme celui ci-dessous.
En fait ce qui pose problème c'est les Tag #include etc que je suis obligé de mettre. Le problème est peut-être évident mais je ne trouve vraiment pas comment faire.

D'avance, merci de votre aide.

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
 
#include "Tools.js"
#include "PS/photoshop_functions.js"
 
function Picture_tools(){
 
}
 
 
Picture_tools.is_image_bitmap = function(link_item){
    var is_bitmap = false;
    var image = link_item.parent;
    var black_and_white_key = app.translateKeyString("$ID/#Links_Black and White");
    if (image.constructor.name == "Image") {
        if(image.space == black_and_white_key){
            is_bitmap = true;
        }
    }
    return is_bitmap
}

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
_img/resize_img.js", line 1: caract?re non autoris?
js: ?#target indesign
js: .^
org.mozilla.javascript.EvaluatorException: Compilation produced 1 syntax errors. (/Users/bastieneichenberger/Desktop/images3/resize_img/resize_test_v2/resize_img/resize_img.js#1)
	at org.mozilla.javascript.tools.ToolErrorReporter.runtimeError(ToolErrorReporter.java:144)
	at org.mozilla.javascript.Parser.parse(Parser.java:596)
	at org.mozilla.javascript.Parser.parse(Parser.java:505)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
	at java.lang.reflect.Method.invoke(Method.java:597)
	at org.mozilla.javascript.MemberBox.invoke(MemberBox.java:161)
	at org.mozilla.javascript.NativeJavaMethod.call(NativeJavaMethod.java:247)
	at org.mozilla.javascript.optimizer.OptRuntime.callN(OptRuntime.java:86)
	at org.mozilla.javascript.gen.file__Users_bastieneichenberger_Desktop_images3_resize_img_resize_test_v2_jsdoc_master_node_modules_jsdoc_src_parser_js_18._c_anonymous_24(Unknown Source)
	at org.mozilla.javascript.gen.file__Users_bastieneichenberger_Desktop_images3_resize_img_resize_test_v2_jsdoc_master_node_modules_jsdoc_src_parser_js_18.call(Unknown Source)
	at org.mozilla.javascript.optimizer.OptRuntime.call2(OptRuntime.java:76)
	at org.mozilla.javascript.gen.file__Users_bastieneichenberger_Desktop_images3_resize_img_resize_test_v2_jsdoc_master_node_modules_jsdoc_src_parser_js_18._c_anonymous_2(Unknown Source)
	at org.mozilla.javascript.gen.file__Users_bastieneichenberger_Desktop_images3_resize_img_resize_test_v2_jsdoc_master_node_modules_jsdoc_src_parser_js_18.call(Unknown Source)
	at org.mozilla.javascript.optimizer.OptRuntime.call2(OptRuntime.java:76)
	at org.mozilla.javascript.gen._Users_bastieneichenberger_Desktop_images3_resize_img_resize_test_v2_jsdoc_master_jsdoc_js_1._c_main_3(Unknown Source)
	at org.mozilla.javascript.gen._Users_bastieneichenberger_Desktop_images3_resize_img_resize_test_v2_jsdoc_master_jsdoc_js_1.call(Unknown Source)
	at org.mozilla.javascript.optimizer.OptRuntime.callName0(OptRuntime.java:108)
	at org.mozilla.javascript.gen._Users_bastieneichenberger_Desktop_images3_resize_img_resize_test_v2_jsdoc_master_jsdoc_js_1._c_script_0(Unknown Source)
	at org.mozilla.javascript.gen._Users_bastieneichenberger_Desktop_images3_resize_img_resize_test_v2_jsdoc_master_jsdoc_js_1.call(Unknown Source)
	at org.mozilla.javascript.ContextFactory.doTopCall(ContextFactory.java:426)
	at org.mozilla.javascript.ScriptRuntime.doTopCall(ScriptRuntime.java:3178)
	at org.mozilla.javascript.gen._Users_bastieneichenberger_Desktop_images3_resize_img_resize_test_v2_jsdoc_master_jsdoc_js_1.call(Unknown Source)
	at org.mozilla.javascript.gen._Users_bastieneichenberger_Desktop_images3_resize_img_resize_test_v2_jsdoc_master_jsdoc_js_1.exec(Unknown Source)
	at org.mozilla.javascript.tools.shell.Main.evaluateScript(Main.java:654)
	at org.mozilla.javascript.tools.shell.Main.processFileSecure(Main.java:552)
	at org.mozilla.javascript.tools.shell.Main.processFile(Main.java:507)
	at org.mozilla.javascript.tools.shell.Main.processSource(Main.java:499)
	at org.mozilla.javascript.tools.shell.Main.processFiles(Main.java:215)
	at org.mozilla.javascript.tools.shell.Main$IProxy.run(Main.java:134)
	at org.mozilla.javascript.Context.call(Context.java:521)
	at org.mozilla.javascript.ContextFactory.call(ContextFactory.java:535)
	at org.mozilla.javascript.tools.shell.Main.exec(Main.java:198)
	at org.mozilla.javascript.tools.shell.Main.main(Main.java:174)

[sekaijin]

Je te propose de regarder jsduck


https://github.com/senchalabs/jsduck
https://github.com/senchalabs/jsduck/wiki
http://sourceforge.net/projects/jsdu...?source=navbar

perso je le trouve facile à utiliser et produit une doc plutot bien faite
si donc tu n'est pas encore arrêté sur ton choix

A+JYT

[SuperArbre]

Hello,

Merci beaucoup à tous… ça fonctionne
Si ça peut servir à quelqu'un c'est possible avec JSDUCK et avec jsdoc_toolkit!
Par contre JSDOC standard fait une erreur si le code n'est pas confirme.

Merci encore