mainpage only recognized in the first path and if it's the only one

DynV - May 11, 2008 - 19:21
Project:API
Version:5.x-1.x-dev
Component:Code
Category:support request
Priority:normal
Assigned:Unassigned
Status:closed
Description

I got the cursed error message and found out how to get rid of it:

A main page for this branch has not been indexed. A documentation comment with @mainpage {title} needs to exist, or has not been indexed yet. For Drupal core, this is availiable in the developer documentation in the contributions repository.

I did a pretty simple index.php including a doxygen main page command and included it in one of the only 2 paths in the Directory name setting. As it was in the second path, it didn't work so I inverted them so it was the first one and it still didn't work, I then cut the second path as well as the separator and the error finally transformed into the main page; I then added the cut second path and the main page was still on and working well.

#1

Damien Tournoud - May 28, 2008 - 14:24
Status:active» postponed (maintainer needs more info)

I'm unsure about the problem you are really facing. Could you elaborate (and include file paths and/or urls if relevant)?

#2

DynV - June 1, 2008 - 00:51

I'll explain this :

I did a pretty simple index.php including a doxygen main page command and included it in one of the only 2 paths in the Directory name setting. As it was in the second path, it didn't work so I inverted them so it was the first one and it still didn't work, I then cut the second path as well as the separator and the error finally transformed into the main page; I then added the cut second path and the main page was still on and working well.

it was in the second path
Y
it didn't work
  1. path/to/X
  2. path/to/Y
I inverted them so it was the first one... it still didn't work
  1. path/to/Y
  2. path/to/X
I then cut the second path... transformed into the main page
  1. path/to/Y
I then added the cut second path... working well
  1. path/to/Y
  2. path/to/X

Would you be so kind to point to literary style that could make my text explanation clearer ?

#3

seanburlington - June 7, 2008 - 17:05
Category:bug report» support request

Hi

I had problems with this too

it isn't where the file is that matters.

The (to me) non-obvious step is that the {title} in your @mainpage must be the same as the "long name" you choose in the api module settings.

I wrote a step by step guide at

http://www.practicalweb.co.uk/blog/08/05/09/documenting-drupal-websites

#4

drumm - January 1, 2009 - 00:01
Status:postponed (maintainer needs more info)» closed
 
 

Drupal is a registered trademark of Dries Buytaert.