Bug 12347 - Series of documentation issues
Summary: Series of documentation issues
Status: CONFIRMED
Alias: None
Product: Android
Classification: Xamarin
Component: General (show other bugs)
Version: 4.8.x
Hardware: PC Mac OS
: High normal
Target Milestone: ---
Assignee: Radek Doulik
URL:
Depends on:
Blocks:
 
Reported: 2013-05-22 12:56 UTC by Miguel de Icaza [MSFT]
Modified: 2017-07-05 20:56 UTC (History)
2 users (show)

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


Attachments

Description Miguel de Icaza [MSFT] 2013-05-22 12:56:55 UTC
The documentation on this page shows various issues with our docs:

http://docs.mono-android.net/?link=T:Android.OS.AsyncTask#

"Here is an example showing subclassing"

Nothing is there, perhaps because it is a Java sample?  We should go and put together all those samples, using Jeremi's framework for this.

Comments like this, that render poorly, why is this being shown to the user? (the part starting with "NoType:")

Not all types are always used by an asynchronous task. To mark a type as unused, simply use the type NoType:java/lang/Void;Href=../../../reference/java/lang/Void.html

Referenced method like:

 (AsyncTask`3.doInBackground(Params...))

Should be converted to their equivalent C# ones.
Comment 1 Jonathan Pryor 2013-05-22 20:11:52 UTC
Maybe we should enable the Java.Lang.Void type? (It's currently hidden, for reasons that the commit history doesn't provide.) That aside...

NoType:... is shown when we can't find the specified Java type to provide a link to the Java type.

Q: What _should_ be done? In this case we could enable Java.Lang.Void (which would allow it to be linked), but in the general case... should we use the original unlinked text? It would be nearly non-sensical:

    To mark a type as unused, simply use the type Void:
Comment 2 Jonathan Pryor 2013-05-22 21:04:21 UTC
Java.Lang.Void is bound in master/39c46bc4. (Again, fixes the immediate issue, but not the general issue.)

Note You need to log in before you can comment on or make changes to this bug.