MuseScore code documentation is available online

[lasconic]

The MuseScore code documentation is available online at http://code.musescore.org. These pages are generated weekly (every monday) based on the current SVN.

The documentation was generated by the build process if doxygen was installed but unfortunatly, a lot of people couldn't read it. Now, an amazon EC2 instance running Ubuntu is launched every week, get current code revision, run doxygen and upload the whole documentation to http://code.musescore.org.

If you never saw the doxygen generated doc, there are nice class inheritance diagrams : http://code.musescore.org/classVolta.html 
There is a bunch of classes, maybe some packages could be removed from the generation to focus on the more "musical".

Documentation can always be improved and this is a good start. Hopefully, having it online will bring more people to help the documentation process.
Suggestion, remarks and documentation patches are welcome !

Enjoy,
Lasconic

------------------------------------------------------------------------------
Download Intel® Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
Mscore-developer mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/mscore-developer

[lasconic]

Hi,

There were some missings images and javascript files. It's fixed. The documentation is now searchable.

http://code.musescore.org

Lasconic

------------------------------------------------------------------------------
Download Intel® Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
Mscore-developer mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/mscore-developer

[Toby Smithe-2]

Hi Lasconic,

2010/2/19 Lasconic <[hidden email]>:
> The MuseScore code documentation is available online at
> http://code.musescore.org. These pages are generated weekly (every monday)
> based on the current SVN.

This is a really useful service; thanks! It might also be useful for
that site to host a weekly diff, so that developers don't need to keep
checking the reference for changes; they could read the docs once, and
then keep up to date by reading the latest diff. Would this be useful
or possible?

All the best,

--
Toby Smithe :: http://tsmithe.net

------------------------------------------------------------------------------
Download Intel&#174; Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
Mscore-developer mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/mscore-developer

[lasconic]

Hi, 

Thanks for the feedback.

I don't see any easy way to do this.

To follow development on a daily base, I use cia.cv rss feeds and I'm quite happy with it : http://cia.vc/stats/project/mscore

Lasconic

2010/2/20 Toby Smithe <[hidden email]>

Hi Lasconic,

2010/2/19 Lasconic <[hidden email]>:

> The MuseScore code documentation is available online at
> http://code.musescore.org. These pages are generated weekly (every monday)
> based on the current SVN.

This is a really useful service; thanks! It might also be useful for
that site to host a weekly diff, so that developers don't need to keep
checking the reference for changes; they could read the docs once, and
then keep up to date by reading the latest diff. Would this be useful
or possible?

All the best,

--
Toby Smithe :: http://tsmithe.net

------------------------------------------------------------------------------
Download Intel&#174; Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
Mscore-developer mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/mscore-developer

[mtherieau]

Am having problems getting to the doxygen pages at http://code.musescore.org.  I seem to be getting re-directed to http://mscore.svn.sourceforge.net/viewvc/mscore/ but I don't see any obvious signs of doxygen pages there?

[Werner Schweer]

Am 21.09.2011 21:52, schrieb mtherieau:

> Am having problems getting to the doxygen pages at http://code.musescore.org.
> I seem to be getting re-directed to
> http://mscore.svn.sourceforge.net/viewvc/mscore/ but I don't see any obvious
> signs of doxygen pages there?
>
>
>
> --
> View this message in context: http://musescore-developer.685061.n2.nabble.com/MuseScore-code-documentation-is-available-online-tp4599635p6817544.html
> Sent from the MuseScore Developer mailing list archive at Nabble.com.
>
> ------------------------------------------------------------------------------
> All the data continuously generated in your IT infrastructure contains a
> definitive record of customers, application performance, security
> threats, fraudulent activity and more. Splunk takes this data and makes
> sense of it. Business sense. IT sense. Common sense.
> http://p.sf.net/sfu/splunk-d2dcopy1
> _______________________________________________
> Mscore-developer mailing list
> [hidden email]
> https://lists.sourceforge.net/lists/listinfo/mscore-developer 

You have to generate the doxygen pages yourself. They are not part of
the source code repository at
sourceforge.net. http://code.musescore.org redirects to the source repo.

/Werner


------------------------------------------------------------------------------
All the data continuously generated in your IT infrastructure contains a
definitive record of customers, application performance, security
threats, fraudulent activity and more. Splunk takes this data and makes
sense of it. Business sense. IT sense. Common sense.
http://p.sf.net/sfu/splunk-d2dcopy1
_______________________________________________
Mscore-developer mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/mscore-developer

[Thomas Bonte]

Hi mtherieau,

We stopped building the docs at code.musescore.org. It was too much maintenance effort for too little benefit.

[mtherieau]

ok -- I'll take a look at generating from source.

thanks,
markt