Bug 62 - Android documentation import: field references aren't converted to links.
Summary: Android documentation import: field references aren't converted to links.
Status: VERIFIED FIXED
Alias: None
Product: Android
Classification: Xamarin
Component: Tools and Addins ()
Version: 1.0
Hardware: PC Mac OS
: --- enhancement
Target Milestone: ---
Assignee: Bugzilla
URL:
Depends on:
Blocks:
 
Reported: 2011-07-26 09:03 UTC by Jonathan Pryor
Modified: 2013-05-13 17:22 UTC (History)
2 users (show)

Tags:
Is this bug a regression?: ---
Last known good build:

Notice (2018-05-24): bugzilla.xamarin.com is now in read-only mode.

Please join us on Visual Studio Developer Community and in the Xamarin and Mono organizations on GitHub to continue tracking issues. Bugzilla will remain available for reference in read-only mode. We will continue to work on open Bugzilla bugs, copy them to the new locations as needed for follow-up, and add the new items under Related Links.

Our sincere thanks to everyone who has contributed on this bug tracker over the years. Thanks also for your understanding as we make these adjustments and improvements for the future.


Please create a new report on Developer Community or GitHub with your current version information, steps to reproduce, and relevant error messages or log files if you are hitting an issue that looks similar to this resolved bug and you do not yet see a matching new report.

Related Links:
Status:
VERIFIED FIXED

Description Jonathan Pryor 2011-07-26 09:03:42 UTC
Look at the documentation for Context.GetExternalFilesDir(string):

http://docs.mono-android.net/Android.Content.Context.GetExternalFilesDir%20(string)

In particular, note the `type` parameter documentation:

    The type of files directory to return. May be null for the root of the
    files directory or one of the following Environment constants for a
    subdirectory: , , , , , , or .

This is unreadable and useless. The javadoc contains:

    The type of files directory to return. May be null for the root of the
    files directory or one of the following Environment constants for a
    subdirectory: DIRECTORY_MUSIC, DIRECTORY_PODCASTS, DIRECTORY_RINGTONES,
    DIRECTORY_ALARMS, DIRECTORY_NOTIFICATIONS, DIRECTORY_PICTURES, or 
    DIRECTORY_MOVIES.

in which the DIRECTORY_* values are links onto android.os.Environment (non-final) fields.

Furthermore, Mono for Android _does_ have those fields, e.g.

http://docs.mono-android.net/Android.OS.Environment.DirectoryMusic

The Android documentation import should properly pick up the links for the DIRECTORY_ fields.
Comment 1 Peter Collins 2013-05-13 17:21:57 UTC
Current documentation for GetExternalFilesDir ( http://androidapi.xamarin.com/?link=M%3aAndroid.Content.Context.GetExternalFilesDir ) displays and links to the Android.OS.Environment.Directory* fields.