haxenme/nme

can't generate dox for libraries that use nme.

Opened this issue · 1 comments

If your compiling your dox for js ( assume nme may not be the only supported ) then this won't work

         #else
            #if jsprime
               if (ptr>0)
               {
                  nme_buffer_resize(ptr,alloced);
               }
               else // fallthrough
            #end
            {
            var new_b = new JsUint8Array(alloced);
            var dest = new JsUint8Array(new_b);
            var copy = length<inSize ? length : inSize;
            for(i in 0...copy)
               dest[i] = b[i];
            b = dest;
            }
         #end

Tried patching a few manually but gave up here are some:

/usr/local/lib/haxeLibrary/nme/6,0,121/src/nme/Loader.hx:226: characters 32-45 : Type not found : nme.html5.Lib
/usr/local/lib/haxeLibrary/nme/6,0,121/src/nme/utils/ByteArray.hx:465: characters 14-38 : Unknown identifier : nme_byte_array_read_file
/usr/local/lib/haxeLibrary/nme/6,0,121/src/nme/utils/ByteArray.hx:720: characters 7-36 : Unknown identifier : nme_byte_array_overwrite_file
Error: Command failed with error 1

suggest adding dox support to nme so easier for user libraries to implement dox and to make nme more visible, I can try to assist if needed, some libraries define some dox related switches to help make the process easier.

Note dox is also often useful way to check your own library as normally all parts of code are compiler checked unlike when just using specific parts.