Raydium 3D Game Engine

Il y'a peu de temps, Mildred à fait le tour des fonctions (et fonctionnalités) encore non documentées de Raydium, à partir de son travail sur les headers.

Cela montre un petit problème dans la facon de procéder pour la doc avec le wiki : la numérotation. Nous sommes par exemple maintenant obligés de rajouter les nouvelles fonctions après le chapitre 32, alors que certaines auraient leur place avant. Autre exemple : j'imagine mal le boulot si on voulait rajouter un nouveau chapitre entre le 2 et le 3.

Avez vous une solution à ce problème ?

ne pas numéroté les fonctions(titres). On peut par contre numéroter les paragraphes !

jette un coup d'oeil dans le bac à sable http://raydium.yoopla.org/wiki/BacASable :p

pour faire des docs y a aussi l'action Trail : http://www.wikini.net/wakka.php?wiki=ActionTrail
Bon dans ce cas c'est pas tres utile
mais pour tutoriels ca pourrait simplifier la navigation

Je pense qu'on va mélanger vos deux suppositions :
- Sur la page principale de la doc, on liste les différents chapitres avec la numérotation auto
- Dans chaque chapitre, on place l'ensemble des fonctions avec la numérotation auto, mais sans reprendre le numéro du chapitre (puisqu'il est possible qu'il change).

Vous voyez ce que je veux dire, et ca vous convient ?

oui, ca me conviens :p

moi aussi

Parfait Je vois que le boulot à déjà commencé, c'est génial

Cette page à le même problème :
http://raydium.yoopla.org/wiki/ApiIndex
Il faut la maintenir en plus du reste.

J'avoue avoir du mal à voir comment maintenir tout ces bidules sans erreurs.
A chaque nouvelle fonction dans Raydium, il faut
- ajouter la fonction aux headers (.h)
- ajouter et coder la fonction au .c
- ajouter la fonction dans la doc
- ajouter la fonction dans l'index de la doc

Ca fait beaucoup de choses (autant de risques de fautes, sans compter la maintenance ensuite), il faudrait vraiment pouvoir ajouter une fonction à la doc beaucoup plus rapidement que ça.
Connaissez vous des outils/scripts capable "d'injecter" des pages dans wikini ? Le principe serait d'écrire la doc des fonctions directement dans les headers de Raydium (raydium/headers/*.h) et de lancer un script qui va mettre à jour directement le wiki.
Si ça n'existe pas, je pense que je vais tenter de le coder (mais avec toute la doc sur une seule page, pour des raisons de simplicité).

Ok, j'ai codé vite fait un script générateur de doc, depuis des commentaires placés dans les fichiers d'entête.
J'ai déplacé vite fait des morceaux de la doc du wiki vers ces fichiers, et voilà le résultat avec le script :
http://raydium.yoopla.org/wiki/TestRayDoc (ca fait déjà 20 pages ! )

C'est correct comme présentation ?

yep, ça reste assez propre mais ne serait-ce pas mieux si l'index se trouvait au tout début !!

Je sais pas trop, ça va faire un sacré paquet de texte avant le "début" de la doc. Par contre, tu as raison, je vais sans doute faire un lien vers l'index au début du document.

Aïe ! Le wiki ne semble pas être capable de gérer des pages trop importantes ! (en "apercu", ça passe, mais quand je sauve, la page est tronquée).
Déjà rencontré ça ? Une option de configuration ? Bug ?

Problème résolu !

Petite expliquation quand meme :
Par defaut, lors de la création de la base de donnée MySQL, wikini defini les champs body et body_r (les champs qui contiennent les pages) en tant que TEXT.
Or un champ TEXT n'est limité qu'a L+2 octets, avec L < 2^16 caractères.

La page TestRayDoc dépassait donc le nombre de caractères max.

J'ai remplacé la valeur TEXT par LONGTEXT (qui permet L+4 octets, avec L < 2^32 caractères) et cela semble fonctionner.

Désolé pour le lag, mais j'ai mis un peu de temps à trouver.

Voila.

_________________
All your base are belong to us.

Génial ! Excellent boulot, flesque
Je me jette tout de suite sur la doc.

Ok, toute la doc du Wiki est reportée dans les sources de Raydium.
Le script marche pas mal du tout, je vais juste rajouter un index des chapitres.
Il me reste à écrire la doc des 7 domaines restants pour Raydium (y'a des chapitres bien costaud dans le tas ) pour que le boulot soit complet. En conséquence, je vais bientot virer la doc actuelle du Wiki pour la remplacer par la nouvelle (très bientot même).

Pour info, les .h qui contiennent la doc frisent les 300 Ko, et la doc imprimée représente plus de 50 pages (53, précisement), pour 34 chapitres. Et c'est pas terminé