|
|
Post by Noel R. Cower on Apr 7, 2004 4:42:43 GMT
I'll just go over a list of what I'd like to suggest be added to Cod2Doc (doin' what you asked, RepeatUntil  ): - A tag for C2D files that starts creation of documentation for a linked file (e.g., ";makedoc filename.bb"). - Header/Footer files. These are one of the things that really can do a world of good for generating anything. For example, the header would contain stuff like "<html><header>..</header><body ..>" and then maybe some stuff like custom text, images, links, etc. and the footer would be some more stuff like text, images, links, etc. and "</body></html>". - Being able to run Cod2Doc from a command-line (I don't know if this is already a feature, but I saw no mention of it). For example, run "Cod2Doc.exe -function_list -only_function CreateVector FileA.bb FileB.bb FileC.bb" and so on and so forth in that manner. This would allow for batch files to be run to generate the documentation (resulting in increased productivity). I don't know whether or not you'd want to include this, though. That's all so far, I'll add anything else if I find anything. |
|
|
|
Post by RepeatUntil on Apr 9, 2004 12:17:33 GMT
Thank you for all these suggestions! Here are my comments.
What will be this for?? Would it be to centralized all documented files in a single file?? What will be the advantage compared to documenting it by clicking on it?
Yes, I think it's a good idea! I will try to implement that!!
At the first moments of Cod2Doc, this was the idea. But it turns out that Cod2Doc has too many options to be practical. HOWEVER, next version of Cod2Doc WILL have the command line (for drag'n'drop feature, and to be launched from an IDE for example). So you could use it also with a batch file. however, no option would be available with the command line: instead, Cod2Doc will use the "configuration file" present in the application tab of the GUI. So in principle you could use soon batch files...
Now I have a question for you: is it a problem for you if I put a link to your documentation in the Cod2Doc web page (to show to users some examples) ??
Thanks using Cod2Doc!!
|
|
|
|
Post by Noel R. Cower on Apr 9, 2004 18:15:36 GMT
Would it be to centralized all documented files in a single file? Yeah. Basically, you could do more laying out on the index that way. And feel free to link to the Vein documentation. |
|
|
|
Post by RepeatUntil on May 1, 2004 10:30:25 GMT
Hi,
This message concerns a suggestion of Noel, but I would be happy to have other people's opinion...
I am working right now on the next version of Cod2Doc, and I have a question about one of the suggestions of Noel:
I am now implementing this nice idea. But I am not a *super* expert in html, and I am not sure why the user should be able to insert stuff between "<html><head>..</head><body>"?? For me, it's enough if the header that the user can insert arrives just after <body> (so that he can easily add images, links, etc). So in my idea Cod2Doc will still generate the "<html><head>..</head><body>" alone (as well as
"</body></html>"). But maybe I am wrong here, and the user might find useful to add some stuff in the html header??
Thanks for your inputs...
|
|
|
|
Post by Noel R. Cower on May 9, 2004 20:17:07 GMT
Well, the point of the header and footer files is typically to insert HTML immediately after <body> or before </body>. You could, for example, put up a logo, table of contents, etc. and integrate it with the website it's hosted on.
Doing something like this would be possible, for example:
For the header, just as an example. Right now, it's rather restricting the way you're doing it (no customization of the HTML output as far as I can see).
For the footer, you could add your own copyright information, links to disclaimers, etc.
|
|
|
|
Post by RepeatUntil on May 19, 2004 12:20:19 GMT
OK, concerning the 3 suggestions in the first post: - new tag ;makeDoc: it's very hard to implement it in the actual coding of Cod2Doc, and would require too many changes. So, sorry, not implemented  - header/footer files: done  - run Cod2Doc from a command line: done. But you will need to specify first the option using the interface of Cod2Doc and the configuration file ("Application" tab). Added a "Save" button to save easily the configuration file. Cod2Doc version 1.2 will be released in a few days. In addition to these improvements, there is a lot more that was done!! Drag'n'Drop, new styles, lot of bugs correction, new tags, callable from an IDE, ... |
|
):
