Nová API dokumentace – kritika a návrhy

nevim jestli to jenom neni ted aktualne nefunkcni ale nejde mi prochazeni pres namespacy a v all classes muzu prohlednout pouze nektere tridy

co uz nekdo jinde psal, moznost vlezt primo do kodu tridy by byla super, klido jen propojeni na github jestli je to nejak mozny

Vidíme všichni to stejné? Kliknout lze na vše, otevřít lze vše, linky na zdrojáky jsou, offline verze je v distribuci… :-/

Má to vypadat stejně jako předchozí verze až na to, že chybí stránky s interfacema? Nebo je chyba u mě?

chrome sem teda veril, ze si cache podrzi i kdyz je obsah uplne jiny sem necekal

kazdopadne je ta dokumentace cupr i s ramama

Editoval despiq (30. 9. 2010 9:45)

@Majkl578: rámy, odkazy +1

@David Grudl: Pěkné, velmi pěkné, těší mě, že se věci hýbou i po skončení WebExpa ;) K dokumentaci:

1. Hezčí vypisování properties a konstant – jako ve staré dokumentaci. U konstant to není tolik nutné, ale u proměnných bylo přehlednější, když byly v samotném sloupečku jejich názvy – hledalo se v tom mnohem rychleji.
2. Bavičky=) Líbilo se mi zvýrazňování kódu ve staré dokumentaci – v té nové je to všechno takové stejné (rozumněj = černé a sem tam zelená) a už jen samotná vidina spousty jednolitých černých bloků mě odrazuje od jakéhokoliv hledání (jo, je tam červená, ale při zběžném pohledu není příliš výrazná).
3. S barvičkami trochu souvisí prolinkování funkcí (ikdyž v té staré dokumentaci byl prolinkován vždy jen jeden výskyt funkce v bloku kódu, což by chtělo doladit).
4. Všiml jsem si chybějících popisů vstupních a výstupních parametrů funkcí a metod. Bohužel si teď vůbec neuvědomuji, zda jsem je používal nebo ne – tak to ukáže až praxe, jestli má význam dávat je do přehledu.

@paranoiq: stačí kliknout rovnou na NO FRAMES

„source i přímo v tabulce metod“++

BTW by se mi líbilo (ikdyž bych si asi trošku vymýšlel) u tříd seznam (přímých?) potomků/u interfaců seznam potomků + seznam tříd implementujících toto rozhraní :)

Už mi to taky jede perfektně :) Konečně jsem zjistil jak se v Chrome maže keš :P

Skvělá práce!

Druhá várka poznámek:

• ty rámce jsou fakt hnus! Míněno smrtelně vážně… I kdyby někdo obhájil jejich uživatelskou přívětivost (což se imho nedá) – stále zůstává fakt že jsou ošklivé a vzhled celého webu naprosto shazují…
  • nedá se vzít adresa z prohlížeče :(
  • verze bez rámů není rovnocená té s rámci ← chybí ty okýnka :)
• uvítal bych větší zvýraznění popisu u metod a (možná) tříd (tam je to takové šedivější ale taky nic moc výrazného) – např. tučnější šedá patková kurzíva jako je .perex na webu

Jinak je to příjemně svižné :)

To není :-)

Davide díky za ty linky na skok do zdrojáku. Jinak dokumentace nativních tříd je určitě dobrý nápad, hodí se to.

@honza dobrý nápad :)

Honza Marek napsal(a):

Já bych uvítal, kdyby se části kódu daly zkopírovat bez čísel řádek, ať se dá nette lépe vykrádat.

Ak je to prakticky mozne a nebol by s tym problem tak +1

Ještě jedna drobnost – šlo by metody v tabulce řadit abecedně? Teď jsou řazené tak jak leží v kódu.

Nejlogičtější by mi přišlo řadit podle modifikátoru přístupu a následně podle abecedy…a staticy nahoru.

+1

@Ondřej Brejla +1

Tak teď to pro změnu nefunguje vůbec… :-D Po kliknutí na jakýkoli odkaz jsem přesměrován na https://api.nette.org/nette/2.0/#…

Cache smazaná… Dělá to v Chrome. V Opeře to funguje ale nemění se kotva. Je tam stále https://api.nette.org/nette/2.0/#…. Ve Firefoxu to funguje na 100%.

David Grudl napsal(a):

Řazení bych asi řešil pomocí JavaScriptu, protože pořadí „jako ve zdrojáku“ mi vyhovuje víc, než podle abecedy.

Myslím, že to je tím, že je to tvůj kód. My ostatní nemáme zažitý tvůj systém jakým řadíš metody od shora dolu, tak potřebujeme nějaký jasnější. Líbil se mi Ondřejův návrh.

ha, tak ted ta api je fakt perfektní :) Možná bych trochu vylepšil typografii stránek typu: https://api.nette.org/…otation.html, kdy je to trochu nepřehledné (ale to bylo ve všech generátorech). Skvělá práce!

Super, pokud nebume používat GUI s JavaScriptem o moc lepší to být nemůže. Skvělá práce!

Ale pokud ano, mohlo by to vypadat třeba takto: http://dev.sencha.com/…oy/dev/docs/

Jsem slepí nebo tam chybí Nette\Application\AppForm?

Predpokladam, ze vysledky, ktere vraci vyhledavaci pole jsou v plne rezii Google, az se raci novou API zaindexovat nebo je nekde bug?
Vsechny odkazy ve vysledcich totiz vedou na „1.0“ verzi API a jsou nefunkcni.

Udělal jsem zase nějaké úpravy a výsledek považuju takřka za finální, takže smažte si cache a kritizujte :-) Zdrojový kód generátoru dokumentace najdete tady.

Váhal jsem, zda dokumentaci ještě upravit do designu webu (jako byla původní), ale mám za to, že z praktického hlediska by to bylo kontraproduktivní a nevím, jak bych v tom řešil ty (pseudo)rámy.

Honza Kuchař napsal(a):
Ale pokud ano, mohlo by to vypadat třeba takto: http://dev.sencha.com/…oy/dev/docs/

To je podle mě úplně strašné :-)

Jde nějak vypnout to příšerné poskakování při hoveru metody?

Uz je mi to trapne opakovat ;-)

SMAŽ KEŠ