Doxygen document C fonctionne dans les projets Objective-C

Question

Je programme un projet en Objective-C et j'ai commencé à utiliser Doxygen pour générer automatiquement de la documentation. Une partie importante du projet contient des fonctions C de base. Malheureusement, Doxygen ne documente pas les fonctions C, seulement les classes Objective-C et leurs méthodes. J'ai les fonctions définies dans plusieurs fichiers d'en-tête comme suit:

BOOL myFunc(void); 

Que j'ai ensuite implémenté dans un.

Doxygen ne détecte-t-il pas les fonctions C droites dans Objective-C ou y a-t-il une option à activer? Ma fonction est-elle mal définie pour Doxygen?

Answer 1

Doxygen documente certainement des fonctions C droites.

Après plus de tests

Utilisez le Doxywizard et vérifier les valeurs en mode expert - il fournit une aide agréable quand vous passez la souris sur les choses. En particulier, vous devriez avoir changé la valeur par défaut est donc EXTRACT_ALL vérifié

Je pense avoir besoin de cette à définir, en face de la valeur par défaut, est peut-être un bug.

Si vous êtes désespéré, affichez les paramètres dans la question. Je viens de créer un échantillon à partir de zéro et j'ai vérifié que votre fonction apparaissait en utilisant Doxygen quand j'utilise EXTRACT_ALL mais il n'y a pas de section File Members si je l'éteins.

Vous devriez voir les fonctions sous Fichiers - Membres de fichiers, comme seen here dans les documents VTK. Désolé je ne l'ai pas ramassé plus tôt mais j'ai toujours EXTRACT_ALL sur comme je travaille sur les bases de code héritées où la plupart des fonctions manquent de commentaires spéciaux.

idée précédente Essayez d'ajouter un commentaire @file en haut du fichier pour voir s'il est en cours de traitement. Je parie que votre extension de fichier ou votre répertoire n'est pas inclus dans le fichier d'installation de doxygen que vous utilisez.