Documentation of a Xojo project

For the technical documentation I don‘t need formatting and write all in notes in a module called „Doc“. This works pretty well.
The documentation for the user with formatted text, screenshots etc. is done in Adobe InDesign.

The UserGuide for my app is also written in Pages and is about 60 A4 pages long.

I really wish the notes functionality was better in Xojo. It seems like such an easy addition to the IDE.

For example, I’ve had a feedback request open for years (I wish I could post the Feedback case number but I haven’t been able to open Feedback for weeks - it keeps crashing on launch) to support Markdown or at least basic formatting (bold, underline, italic, etc) in notes.

There is also a nasty bug that I have been unable to reliably reproduce that occasionally (but often enough it is disruptive) messes up the formatting of a note. Sometimes it removes newlines, sometimes it removes entire chunks of text from a note.

What I do now is extensively document the top of each method in my own style. I also make extensive use of the description field in the IDE to give a short summary of what every class property and method does.

1 Like

He is asking for documenting the Xojo PROJECT INSIDE the IDE, not for an app.

I do use the notes and yes, they suck, the lack of markup made my notes look like some ancient DOS app, you know, full of ascii chars. It is ugly and impractical but it works with the plain text.

====================================
-----   Here goes the title   ------
====================================

I’d rather Xojo stuck to new features and bug fixes, myself. Other apps exist for doing documentation.

1 Like

There’s an app called like “XJDocs” or something like that - will remember at some point. But its able to load a project file and automatically create docs for Xojo projects. Someone will probably remember the name quicker than I can - it’s alluding me at the moment…

https://parkbenchsoftware.com/xjDocs/index.html

2 Likes

You’re amazing @Jean-Yves_Pochez!

The notes feature is buggy.

Name a SINLGE app for doing documentation of a Xojo project inside the IDE :roll_eyes:

Who uses notes in a project?

I do.

Who has a project to create Nice HTML / PDF documentation of the project???

Yes, my primary app is documented extensively using MS Word, I print to PDF from that.

The more important question (not asked) is who has a detailed HELP menu, and documentation that is searchable ?

One issue is understanding your intended audience - a programmer taking over your code, or users ?

The title of this thread is “Documentation of a Xojo Project”. So, not limited to docs inside a Project, which perforce is limited to comments and Notes.

I have to write in case something happens to me …
(Most likely on heart failure because of the frustration due to the lack of good documentation possibilities in Xojo :face_with_hand_over_mouth:)

Thanx Guys I will take a look to it…

I think Xojo must first decide if they wanna play in the “professional development league” or stay in the “hobby league…” Looking at Xojo I think they try to bump up to the professional league… If so, then they have to step up to it… If a reasonable requests (as the one of Garry’s) stays in feedback for couple of years because of lack of resources at Xojo, and if it’s financial not possible for Xojo to get more resources … then they have to focus on parts that already in place fix bugs and make the product competitive to a Jetbrain IDE, instead of expanding new OS’s and have multiple os’s in a limited way with a crapy IDE (come on, when we fix something on the left , something on the right breaks … and vice versa )…
Perhaps if they had done a better job on documentation … this would not be the case …

So… Markup :slight_smile:

Thanx guys for me … thread closed, thanx for your responses

You can create a script that Add this kind of comments…

Wauwwww!!! Perfect!!!
Regarding stepping up as Xojo to “the professional league”… why doesn’t buy @Geoff_Perlman not the code of Park Bench software and integrate it into Xojo… This is what we need …

(ok ok … one feature request for xjDocs why don’t use the description of a object (as is in Xojo)
(but it’s also possible that this is allready the case and I have not found it yet))…
xjDocs is now for free… so I think if Geoff gives pays 2k … everybody is happy…

I wonder… “What means “Pro” in the “hobby league” ?”

Use a Jetbrain developers IDE and see how it works… The warnings and autocomplete on editing are superb.

So lets call that development tools “Pro League” (because there are more good coding IDE’s)
Compare it to the Xojo IDE and you start to understand “Hobby League” …

Don’t get me wrong … I Love Xojo :smiling_face_with_three_hearts:
Working 14 years (something like that) with Xojo.

But Xojo IDE is having some long lasting problems and lack of features.
One of the reasons that we have a new Xojo IDE instead of Realbasic IDE is that we had more space for new features… well there is more space for many years now, but new features…??

Simple example? Refactoring names of Methods / variables etc etc … IDE doesn’t know where to find… So a simple find and replace is the only option you have …

A module (perfect mechanism for reusing libs) … You can’t make them external like a class…
Do I need to continue ???

you can make a module external. except if it contains a class then it is not possible.

Yeah I know… but are classes not the essence of object based programming??? :thinking:
And are modules not just a pretty way to organize your classes in a project…
along with methods towards to the rest of your application can talk to … is like … like … like a library full of powerfull functions… :nerd_face:

It would be Nice / essential to have a library that’s external … :sunglasses:

See this topic… Feature Request - Add Markdown formatting to Notes

On a slightly related issue… Object Documentation